LifeV
BCInterfaceFunction< BcHandlerType, PhysicalSolverType > Class Template Referenceabstract

BCInterfaceFunction - Base class for BCInterface boundary functions. More...

#include <BCInterfaceFunction.hpp>

+ Inheritance diagram for BCInterfaceFunction< BcHandlerType, PhysicalSolverType >:

Type definitions

typedef BcHandlerType bcHandler_Type
 
typedef PhysicalSolverType physicalSolver_Type
 
typedef bcHandler_Type::bcFunction_Type bcBase_Type
 
typedef BCInterfaceData data_Type
 
typedef std::shared_ptr< data_Type > dataPtr_Type
 
typedef std::function< Real(const Real &) > boundaryFunctionTime_Type
 
typedef std::function< Real(const Real &, const Real &) > boundaryFunctionTimeTimeStep_Type
 
typedef std::function< Real(const Real &, const Real &, const Real &, const Real &, const ID &) > boundaryFunctionTimeSpaceID_Type
 

Constructors & Destructor

 BCInterfaceFunction ()
 Empty Constructor. More...
 
virtual ~BCInterfaceFunction ()
 Destructor. More...
 

Methods

virtual void assignFunction (bcBase_Type &base)=0
 Assign the function to the base of the BCHandler. More...
 
virtual Real functionTime (const Real &t)=0
 Function of time. More...
 
virtual Real functionTimeTimeStep (const Real &t, const Real &timeStep)=0
 Function of time and time step. More...
 
virtual Real functionTimeSpace (const Real &t, const Real &x, const Real &y, const Real &z, const ID &)=0
 Function of time and space. More...
 
virtual Real functionTimeSpaceID (const Real &t, const Real &x, const Real &y, const Real &z, const ID &id)=0
 Function of time and space with ID. More...
 

Set Methods

virtual void setData (const dataPtr_Type &data)=0
 Set data for boundary conditions. More...
 

Unimplemented Methods

 BCInterfaceFunction (const BCInterfaceFunction &function)
 
BCInterfaceFunction & operator= (const BCInterfaceFunction &function)
 

Detailed Description

template<typename BcHandlerType, typename PhysicalSolverType>
class LifeV::BCInterfaceFunction< BcHandlerType, PhysicalSolverType >

BCInterfaceFunction - Base class for BCInterface boundary functions.

Author
Cristiano Malossi

This class provides the interface between the BCInterface and the boundary functions.

Definition at line 54 of file BCInterfaceFunction.hpp.

Member Typedef Documentation

◆ bcHandler_Type

typedef BcHandlerType bcHandler_Type

Definition at line 61 of file BCInterfaceFunction.hpp.

◆ physicalSolver_Type

typedef PhysicalSolverType physicalSolver_Type

Definition at line 62 of file BCInterfaceFunction.hpp.

◆ bcBase_Type

typedef bcHandler_Type::bcFunction_Type bcBase_Type

Definition at line 64 of file BCInterfaceFunction.hpp.

◆ data_Type

typedef BCInterfaceData data_Type

Definition at line 66 of file BCInterfaceFunction.hpp.

◆ dataPtr_Type

typedef std::shared_ptr< data_Type > dataPtr_Type

Definition at line 67 of file BCInterfaceFunction.hpp.

◆ boundaryFunctionTime_Type

typedef std::function<Real ( const Real& ) > boundaryFunctionTime_Type

Definition at line 69 of file BCInterfaceFunction.hpp.

◆ boundaryFunctionTimeTimeStep_Type

typedef std::function<Real ( const Real&, const Real& ) > boundaryFunctionTimeTimeStep_Type

Definition at line 70 of file BCInterfaceFunction.hpp.

◆ boundaryFunctionTimeSpaceID_Type

typedef std::function<Real ( const Real&, const Real&, const Real&, const Real&, const ID& ) > boundaryFunctionTimeSpaceID_Type

Definition at line 71 of file BCInterfaceFunction.hpp.

Constructor & Destructor Documentation

◆ BCInterfaceFunction() [1/2]

BCInterfaceFunction ( )
inlineexplicit

Empty Constructor.

Definition at line 80 of file BCInterfaceFunction.hpp.

◆ ~BCInterfaceFunction()

virtual ~BCInterfaceFunction ( )
inlinevirtual

Destructor.

Definition at line 83 of file BCInterfaceFunction.hpp.

◆ BCInterfaceFunction() [2/2]

BCInterfaceFunction ( const BCInterfaceFunction< BcHandlerType, PhysicalSolverType > &  function)
private

Member Function Documentation

◆ assignFunction()

virtual void assignFunction ( bcBase_Type &  base)
pure virtual

Assign the function to the base of the BCHandler.

Parameters
basebase of the boundary condition

Implemented in BCInterfaceFunctionParser< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionParser< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionParser< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionParser< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionParser< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionParser< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionParser< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionParser< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionParser< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionParser< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionParser< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionParser< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionParser< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionParser< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionParser< BcHandlerType, PhysicalSolverType >, and BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >.

◆ functionTime()

virtual Real functionTime ( const Real &  t)
pure virtual

Function of time.

Parameters
ttime
Returns
boundary condition value

Implemented in BCInterfaceFunctionParser< BcHandlerType, PhysicalSolverType >, and BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >.

◆ functionTimeTimeStep()

virtual Real functionTimeTimeStep ( const Real &  t,
const Real &  timeStep 
)
pure virtual

Function of time and time step.

Parameters
ttime
timeSteptime step
Returns
boundary condition value

Implemented in BCInterfaceFunctionParser< BcHandlerType, PhysicalSolverType >, and BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >.

◆ functionTimeSpace()

virtual Real functionTimeSpace ( const Real &  t,
const Real &  x,
const Real &  y,
const Real &  z,
const ID &   
)
pure virtual

Function of time and space.

Parameters
ttime
xx coordinate
yy coordinate
zz coordinate
idid of the boundary condition (not used)
Returns
boundary condition value

Implemented in BCInterfaceFunctionParser< BcHandlerType, PhysicalSolverType >, and BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >.

◆ functionTimeSpaceID()

virtual Real functionTimeSpaceID ( const Real &  t,
const Real &  x,
const Real &  y,
const Real &  z,
const ID &  id 
)
pure virtual

Function of time and space with ID.

Parameters
ttime
xx coordinate
yy coordinate
zz coordinate
idid of the boundary condition
Returns
boundary condition value

Implemented in BCInterfaceFunctionParser< BcHandlerType, PhysicalSolverType >, and BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >.

◆ setData()

virtual void setData ( const dataPtr_Type &  data)
pure virtual

Set data for boundary conditions.

Parameters
databoundary condition data loaded from GetPot file

Implemented in BCInterfaceFunctionParser< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionParserSolver< BcHandlerType, PhysicalSolverType >, BCInterfaceFunctionParserFile< BcHandlerType, PhysicalSolverType >, and BCInterfaceFunctionParserFileSolver< BcHandlerType, PhysicalSolverType >.

◆ operator=()

BCInterfaceFunction& operator= ( const BCInterfaceFunction< BcHandlerType, PhysicalSolverType > &  function)
private
The documentation for this class was generated from the following file: