FieldsFuncBase Class Reference

Base class for multi-valued spatial functions, defined through fields. More...

#include <FieldFunctions.h>

Inheritance diagram for FieldsFuncBase:

Collaboration diagram for FieldsFuncBase:

Protected Member Functions
	FieldsFuncBase (const std::vector< Fields * > &fields)
	Construct from vector of fields. More...
	FieldsFuncBase (const std::string &fileName, const std::string &basisName, const std::string &fieldName, int level)
	The constructor creates a field from the provided HDF5-file. More...
virtual	~FieldsFuncBase ()
	The destructor deletes the vector fields.
virtual void	addPatchField (ASMbase *pch, const std::vector< Real > &coefs, int nf, int basis)
	Adds a patch-wise field with the given coefficient values. More...
virtual void	clearField ()
	Clears the field container.
std::vector< Real >	getValues (const Vec3 &X)
	Evaluates the field at the givent point X.
std::vector< Real >	getGradient (const Vec3 &X) const
	Evaluates the field gradient at the givent point X.
std::vector< Real >	getHessian (const Vec3 &X) const
	Evaluates the field gradient at the givent point X.
Protected Member Functions inherited from FieldFuncHDF5
	FieldFuncHDF5 ()
	Default constructor.
	FieldFuncHDF5 (const std::string &fileName)
	The constructor opens the provided HDF5-file. More...
	FieldFuncHDF5 (const FieldFuncHDF5 &)=delete
	No copying of this class.
virtual	~FieldFuncHDF5 ()
	The destructor closes the HDF5-file.
bool	load (const std::vector< std::string > &fieldNames, const std::string &basisName, int level, bool isScalar=false)
	Loads field values for the specified time level. More...
int	findClosestLevel (double time) const
	Finds the level whose time is closest to the specified time.
Protected Member Functions inherited from FieldFuncBase
	FieldFuncBase ()
	Default constructor.
	FieldFuncBase (const FieldFuncBase &)=delete
	No copying of this class.
virtual	~FieldFuncBase ()
	The destructor deletes the patches.
bool	setPatch (size_t pIdx)
	Sets the active patch.

Protected Attributes
std::vector< std::string >	fName
	Name of field components.
std::string	bName
	Name of basis.
std::vector< Fields * >	field
	The vector field to be evaluated.
Protected Attributes inherited from FieldFuncHDF5
bool	hasMultipleLevels
	True if we have multiple time levels.
int	lastLevel
	The last time level read from.
Protected Attributes inherited from FieldFuncBase
std::vector< ASMbase * >	patch
	The patches on which the field is defined.
size_t	pidx
	Current patch index.
size_t	npch
	Number of patches in the field.

Private Attributes
int	currentLevel
	Current time level to evaluate at.

Additional Inherited Members
Static Public Attributes inherited from FieldFuncBase
static constexpr int	FIXED_LEVEL = 1 << 24
	Bit flag in level for using fixed.

Detailed Description

Base class for multi-valued spatial functions, defined through fields.

Constructor & Destructor Documentation

FieldsFuncBase() [1/2]

FieldsFuncBase::FieldsFuncBase ( const std::vector< Fields * > &  fields )

protected

Construct from vector of fields.

Parameters

fields

Fields to use

References FieldFuncHDF5::hasMultipleLevels, and FieldFuncHDF5::lastLevel.

FieldsFuncBase() [2/2]

FieldsFuncBase::FieldsFuncBase ( const std::string &  fileName, const std::string &  basisName, const std::string &  fieldName, int  level  )

protected

The constructor creates a field from the provided HDF5-file.

Parameters

[in]	fileName	Name of the HDF5-file
[in]	basisName	Name of the basis which the field values refer to
[in]	fieldName	Name of the field in the HDF5-file
[in]	level	Time level to read for

Member Function Documentation

addPatchField()

void FieldsFuncBase::addPatchField ( ASMbase *  pch, const std::vector< Real > &  coefs, int  nf, int  basis  )

protectedvirtual

Adds a patch-wise field with the given coefficient values.

Parameters

[in]	pch	The patch to define the field over
[in]	coefs	Field values
[in]	nf	Number of field components
[in]	basis	Basis to use

Implements FieldFuncHDF5.

References Fields::create(), field, and FieldFuncBase::npch.

---

The documentation for this class was generated from the following files:

• src/Utility/FieldFunctions.h
• src/Utility/FieldFunctions.C