 |
CEPS
24.01
Cardiac ElectroPhysiology Simulator
|
|
CEPS
24.01
Cardiac ElectroPhysiology Simulator
|
Functor that gets its result from an array.
Can be initialized with data (then data is copied into the class instance), a pointer to data (then data is not copied), or from a vtk or msh file (data is stored in class instance)
A Flag must be specified at instantiation of ArraySAFunc objects, in order to tell if data must be accessed with nodeIDs or cellIDs
Definition at line 50 of file ArraySAFunc.hpp.
#include <ArraySAFunc.hpp>
Public Member Functions | |
| ArraySAFunc (const ArraySAFunc &)=default | |
| We allow the copy from a functor to another. More... | |
| ArraySAFunc & | operator= (const ArraySAFunc &)=default |
| We allow the assignement from a functor to another. More... | |
| ArraySAFunc (const DistributedInfos< _Result > &data, const CepsFunctionFlag &loc) | |
| Constructor with array, data is copied. More... | |
| ArraySAFunc (DistributedInfos< _Result > *data, const CepsFunctionFlag &loc) | |
| Constructor with array ptr, data is NOT copied. More... | |
| ArraySAFunc (const CepsString &fileName, const CepsString &arrayName, const CepsFunctionFlag &loc, Geometry *geom) | |
| Constructor with a vtk or msh file, data is copied. More... | |
| ArraySAFunc (DHVecPtr src, DistributedInfos< DegreeOfFreedom * > *dofs) | |
| Constructor with a DistributedHaloVector, data is COPIED from the vector into this class. It means that data will NOT change during execution. (unless a setValues method is implemented later on) The src vector must have the same structure has the dofs distributed info. More... | |
| ~ArraySAFunc () | |
| Destructor. More... | |
| virtual _Result | eval (CepsStandardArgs args) final |
| Call operator to evaluate functor. More... | |
| CepsEnum | getFlags () const final |
| The final flag is a combination of Attribute and of the flags of the stored object type (if it has any) More... | |
 Public Member Functions inherited from SAFunc< _Result > | |
| SAFunc (const SAFunc &)=default | |
| We allow the copy from a functor to another. More... | |
| SAFunc & | operator= (const SAFunc &)=default |
| We allow the assignement from a functor to another. More... | |
| virtual void | getLocalData () |
| Authorize access to data for solvecSAFunc, other derived classes : nothing. More... | |
| virtual void | releaseLocalData () |
| Authorize access to data for solvecSAFunc, other derived classes : nothing. More... | |
| CepsBool | hasOption (CepsFunctionFlag flag) |
| Tells if option is activated. More... | |
Protected Member Functions | |
| void | checkLocation (const CepsFunctionFlag &loc) |
| Determines if flag passed in constructor is valid (cells or nodes ID) More... | |
Protected Attributes | |
| CepsFunctionFlag | m_location |
| Where the data is defined (point, cell) More... | |
| CepsBool | m_dataOwned |
| Flag telling if data structure is created by this instance. More... | |
| DistributedInfos< _Result > * | m_data |
| Ptr to data. More... | |
Additional Inherited Members | |
| Public Types inherited from SAFunc< _Result > | |
| using | BaseFunction = ceps::Function< _Result(CepsStandardArgs)> |
| Typedef for the function type. More... | |
|
default |
We allow the copy from a functor to another.
| ArraySAFunc< _Result >::ArraySAFunc | ( | const DistributedInfos< _Result > & | data, |
| const CepsFunctionFlag & | loc | ||
| ) |
Constructor with array, data is copied.
| ArraySAFunc< _Result >::ArraySAFunc | ( | DistributedInfos< _Result > * | data, |
| const CepsFunctionFlag & | loc | ||
| ) |
Constructor with array ptr, data is NOT copied.
| ArraySAFunc< _Result >::ArraySAFunc | ( | const CepsString & | fileName, |
| const CepsString & | arrayName, | ||
| const CepsFunctionFlag & | loc, | ||
| Geometry * | geom | ||
| ) |
Constructor with a vtk or msh file, data is copied.
| fileName | file from where data is fetched |
| arrayName | name of array in the file |
| loc | location of data (either nodes or cells) |
| geom | link to a geometry (this is to perform a check: coeff readers are incompatible with multiple mesh geometries) |
| ArraySAFunc< _Result >::ArraySAFunc | ( | DHVecPtr | src, |
| DistributedInfos< DegreeOfFreedom * > * | dofs | ||
| ) |
Constructor with a DistributedHaloVector, data is COPIED from the vector into this class. It means that data will NOT change during execution. (unless a setValues method is implemented later on) The src vector must have the same structure has the dofs distributed info.
| [in] | src | data source |
| [in] | dofs | a structure of degrees of freedom (as stored in AbstractDiscretization) from which we extract dof ownership |
| ArraySAFunc< _Result >::~ArraySAFunc | ( | ) |
Destructor.
|
protected |
Determines if flag passed in constructor is valid (cells or nodes ID)
|
finalvirtual |
Call operator to evaluate functor.
|
finalvirtual |
The final flag is a combination of Attribute and of the flags of the stored object type (if it has any)
Implements SAFunc< _Result >.
|
default |
We allow the assignement from a functor to another.
|
protected |
Ptr to data.
Definition at line 109 of file ArraySAFunc.hpp.
|
protected |
Flag telling if data structure is created by this instance.
Definition at line 108 of file ArraySAFunc.hpp.
|
protected |
Where the data is defined (point, cell)
Definition at line 107 of file ArraySAFunc.hpp.
1.9.1