CEPS  24.01
Cardiac ElectroPhysiology Simulator
Public Member Functions | Protected Member Functions | Protected Attributes
FileInterpolatorSAFunc Class Reference

Detailed Description

Functor that uses data from a collection of files to return a value at position x and time t.

Definition at line 39 of file FileInterpolatorSAFunc.hpp.

#include <FileInterpolatorSAFunc.hpp>

Inheritance diagram for FileInterpolatorSAFunc:
[legend]

Public Member Functions

 FileInterpolatorSAFunc (AbstractPdeProblem *pb, CepsReal snapTimeRef, const CepsString &filesBase, CepsUInt tOrder=1)
 Constructor with map. Flag is the expected flag of the coefficient used to interpolate. More...
 
 FileInterpolatorSAFunc (const FileInterpolatorSAFunc &)=default
 We allow the copy from a functor to another. More...
 
FileInterpolatorSAFunc & operator= (const FileInterpolatorSAFunc &)=default
 We allow the assignement from a functor to another. More...
 
virtual CepsReal eval (CepsStandardArgs args) final
 Call operator to evaluate functor. More...
 
CepsEnum getFlags () const final
 flag is Attribute only More...
 
- Public Member Functions inherited from SAFunc< CepsReal >
 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 computeInterpolationWeights ()
 Computes the interpolation weights using geom locators. More...
 
CepsString getVtkFileName (CepsUInt i) const
 Get full file name for snapshot i. More...
 
void loadFilesForTime (CepsReal t)
 Loads the appropriate files to perform time interpolation at time t. More...
 

Protected Attributes

AbstractPdeProblem * m_problem
 Link to problem. More...
 
CepsReal m_snapTimeRef
 Reference output period. More...
 
CepsUInt m_tOrder
 Time interpolation order. More...
 
CepsString m_filesBase
 Base names of data files. More...
 
CepsUInt m_nDigitsFile
 Number of digits of file number in collection of files. More...
 
CepsReal m_loadedTMin
 Time of Min snapshot of currently loaded files. More...
 
CepsReal m_loadedTMax
 Time of Max snapshot of currently loaded files. More...
 
CepsUInt m_loadedSnapIdMin
 Min snapshot ID of currently loaded files. More...
 
CepsUInt m_loadedSnapIdMax
 Max snapshot ID of currently loaded files Loaded data, indexed by time, unknown id (array name in vtk file), vtk point id. More...
 
CepsVector< CepsMap< CepsUnknownIndex, CepsVector< CepsReal > > > m_loadedData
 
CepsVector< CepsMap< CepsUnknownIndex, CepsReal > > m_loadedData0D
 Loaded data, indexed by time, unknown id (array name in vtk file) More...
 
CepsMap< CepsDofGlobalIndex, CepsMap< vtkIdType, CepsReal > > m_itpWeights
 Precomputed interpolation weights. Built using point/cell locator. More...
 
CepsReal m_ptLocatorTolerance
 Distance under which closest point search is tolerated (can be set in input file) More...
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ FileInterpolatorSAFunc() [1/2]

FileInterpolatorSAFunc::FileInterpolatorSAFunc ( AbstractPdeProblem *  pb,
CepsReal  snapTimeRef,
const CepsString &  filesBase,
CepsUInt  tOrder = 1 
)
explicit

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

Definition at line 38 of file FileInterpolatorSAFunc.cpp.

◆ FileInterpolatorSAFunc() [2/2]

FileInterpolatorSAFunc::FileInterpolatorSAFunc ( const FileInterpolatorSAFunc &  )
default

We allow the copy from a functor to another.

Member Function Documentation

◆ computeInterpolationWeights()

void FileInterpolatorSAFunc::computeInterpolationWeights ( )
protected

Computes the interpolation weights using geom locators.

Definition at line 156 of file FileInterpolatorSAFunc.cpp.

◆ eval()

CepsReal FileInterpolatorSAFunc::eval ( CepsStandardArgs  args)
finalvirtual

Call operator to evaluate functor.

Definition at line 90 of file FileInterpolatorSAFunc.cpp.

◆ getFlags()

CepsEnum FileInterpolatorSAFunc::getFlags ( ) const
finalvirtual

flag is Attribute only

Implements SAFunc< CepsReal >.

Definition at line 143 of file FileInterpolatorSAFunc.cpp.

◆ getVtkFileName()

CepsString FileInterpolatorSAFunc::getVtkFileName ( CepsUInt  i) const
protected

Get full file name for snapshot i.

Definition at line 241 of file FileInterpolatorSAFunc.cpp.

◆ loadFilesForTime()

void FileInterpolatorSAFunc::loadFilesForTime ( CepsReal  t)
protected

Loads the appropriate files to perform time interpolation at time t.

Definition at line 250 of file FileInterpolatorSAFunc.cpp.

◆ operator=()

FileInterpolatorSAFunc& FileInterpolatorSAFunc::operator= ( const FileInterpolatorSAFunc &  )
default

We allow the assignement from a functor to another.

Field Documentation

◆ m_filesBase

CepsString FileInterpolatorSAFunc::m_filesBase
protected

Base names of data files.

Definition at line 85 of file FileInterpolatorSAFunc.hpp.

◆ m_itpWeights

CepsMap<CepsDofGlobalIndex,CepsMap<vtkIdType,CepsReal> > FileInterpolatorSAFunc::m_itpWeights
protected

Precomputed interpolation weights. Built using point/cell locator.

Definition at line 98 of file FileInterpolatorSAFunc.hpp.

◆ m_loadedData

CepsVector<CepsMap<CepsUnknownIndex,CepsVector<CepsReal> > > FileInterpolatorSAFunc::m_loadedData
protected

Definition at line 93 of file FileInterpolatorSAFunc.hpp.

◆ m_loadedData0D

CepsVector<CepsMap<CepsUnknownIndex,CepsReal> > FileInterpolatorSAFunc::m_loadedData0D
protected

Loaded data, indexed by time, unknown id (array name in vtk file)

Definition at line 95 of file FileInterpolatorSAFunc.hpp.

◆ m_loadedSnapIdMax

CepsUInt FileInterpolatorSAFunc::m_loadedSnapIdMax
protected

Max snapshot ID of currently loaded files Loaded data, indexed by time, unknown id (array name in vtk file), vtk point id.

Definition at line 91 of file FileInterpolatorSAFunc.hpp.

◆ m_loadedSnapIdMin

CepsUInt FileInterpolatorSAFunc::m_loadedSnapIdMin
protected

Min snapshot ID of currently loaded files.

Definition at line 90 of file FileInterpolatorSAFunc.hpp.

◆ m_loadedTMax

CepsReal FileInterpolatorSAFunc::m_loadedTMax
protected

Time of Max snapshot of currently loaded files.

Definition at line 89 of file FileInterpolatorSAFunc.hpp.

◆ m_loadedTMin

CepsReal FileInterpolatorSAFunc::m_loadedTMin
protected

Time of Min snapshot of currently loaded files.

Definition at line 88 of file FileInterpolatorSAFunc.hpp.

◆ m_nDigitsFile

CepsUInt FileInterpolatorSAFunc::m_nDigitsFile
protected

Number of digits of file number in collection of files.

Definition at line 86 of file FileInterpolatorSAFunc.hpp.

◆ m_problem

AbstractPdeProblem* FileInterpolatorSAFunc::m_problem
protected

Link to problem.

Definition at line 82 of file FileInterpolatorSAFunc.hpp.

◆ m_ptLocatorTolerance

CepsReal FileInterpolatorSAFunc::m_ptLocatorTolerance
protected

Distance under which closest point search is tolerated (can be set in input file)

Definition at line 101 of file FileInterpolatorSAFunc.hpp.

◆ m_snapTimeRef

CepsReal FileInterpolatorSAFunc::m_snapTimeRef
protected

Reference output period.

Definition at line 83 of file FileInterpolatorSAFunc.hpp.

◆ m_tOrder

CepsUInt FileInterpolatorSAFunc::m_tOrder
protected

Time interpolation order.

Definition at line 84 of file FileInterpolatorSAFunc.hpp.

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