CEPS  24.01
Cardiac ElectroPhysiology Simulator
CoeffInterpolatorSAFunc< _Result > Class Template Reference

Detailed Description

template<typename _Result>
class CoeffInterpolatorSAFunc< _Result >

Functions with result that is deduced from a coefficient and an interpolation map.

Interpolation is linear. Could be enhanced, for sure.

Template Parameters
_ResultThe result type of the stored object
_ObjectThe type of stored object

Definition at line 43 of file InterpolationSAFunc.hpp.

#include <InterpolationSAFunc.hpp>

Inheritance diagram for CoeffInterpolatorSAFunc< _Result >:
[legend]

Public Member Functions

 CoeffInterpolatorSAFunc (const CepsMap< CepsReal, _Result > &map, ScalarSAFunc *coeff)
 Constructor with map. Flag is the expected flag of the coefficient used to interpolate. More...
 
 CoeffInterpolatorSAFunc (const CoeffInterpolatorSAFunc &)=default
 We allow the copy from a functor to another. More...
 
CoeffInterpolatorSAFuncoperator= (const CoeffInterpolatorSAFunc &)=default
 We allow the assignement from a functor to another. More...
 
_Result eval (CepsStandardArgs args) final
 Call operator to evaluate functor. More...
 
CepsEnum getFlags () const final
 flag is Attribute only More...
 
void setCoeff (ScalarSAFunc *coeff)
 Sets the selector function for standard args. More...
 
- Public Member Functions inherited from SAFunc< _Result >
 SAFunc (const SAFunc &)=default
 We allow the copy from a functor to another. More...
 
SAFuncoperator= (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 Attributes

CepsMap< CepsReal, _Result > m_map
 The mapping between regions and values. More...
 
ScalarSAFuncm_coeff
 Scalar function used to interpolate. More...
 

Additional Inherited Members

- Public Types inherited from SAFunc< _Result >
using BaseFunction = ceps::Function< _Result(CepsStandardArgs)>
 Typedef for the function type. More...
 

Constructor & Destructor Documentation

◆ CoeffInterpolatorSAFunc() [1/2]

template<typename _Result >
CoeffInterpolatorSAFunc< _Result >::CoeffInterpolatorSAFunc ( const CepsMap< CepsReal, _Result > &  map,
ScalarSAFunc coeff 
)
explicit

Constructor with map. Flag is the expected flag of the coefficient used to interpolate.

◆ CoeffInterpolatorSAFunc() [2/2]

template<typename _Result >
CoeffInterpolatorSAFunc< _Result >::CoeffInterpolatorSAFunc ( const CoeffInterpolatorSAFunc< _Result > &  )
default

We allow the copy from a functor to another.

Member Function Documentation

◆ eval()

template<typename _Result >
_Result CoeffInterpolatorSAFunc< _Result >::eval ( CepsStandardArgs  args)
final

Call operator to evaluate functor.

◆ getFlags()

template<typename _Result >
CepsEnum CoeffInterpolatorSAFunc< _Result >::getFlags ( ) const
finalvirtual

flag is Attribute only

Implements SAFunc< _Result >.

◆ operator=()

template<typename _Result >
CoeffInterpolatorSAFunc& CoeffInterpolatorSAFunc< _Result >::operator= ( const CoeffInterpolatorSAFunc< _Result > &  )
default

We allow the assignement from a functor to another.

◆ setCoeff()

template<typename _Result >
void CoeffInterpolatorSAFunc< _Result >::setCoeff ( ScalarSAFunc coeff)

Sets the selector function for standard args.

Field Documentation

◆ m_coeff

template<typename _Result >
ScalarSAFunc* CoeffInterpolatorSAFunc< _Result >::m_coeff
protected

Scalar function used to interpolate.

Definition at line 78 of file InterpolationSAFunc.hpp.

◆ m_map

template<typename _Result >
CepsMap<CepsReal,_Result> CoeffInterpolatorSAFunc< _Result >::m_map
protected

The mapping between regions and values.

Definition at line 75 of file InterpolationSAFunc.hpp.


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