BCInterfaceFunctionUserDefined - User defined functions for BCInterface. More...

#include <BCInterfaceFunctionUserDefined.hpp>

Inheritance diagram for BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >:

Collaboration diagram for BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >:

Public Member Functions
template<>
void	assignFunction (bcBase_Type &base)
	Assign the function to the base of the `BCHandler`. More...

template<>
void	assignFunction (bcBase_Type &base)
	Assign the function to the base of the `BCHandler`. More...

template<>
void	assignFunction (bcBase_Type &base)
	Assign the function to the base of the `BCHandler`. More...

template<>
void	assignFunction (bcBase_Type &base)
	Assign the function to the base of the `BCHandler`. More...

template<>
void	assignFunction (bcBase_Type &base)
	Assign the function to the base of the `BCHandler`. More...

template<>
void	assignFunction (bcBase_Type &base)
	Assign the function to the base of the `BCHandler`. More...

template<>
void	assignFunction (bcBase_Type &base)
	Assign the function to the base of the `BCHandler`. More...

template<>
void	assignFunction (bcBase_Type &base)
	Assign the function to the base of the `BCHandler`. More...

template<>
void	assignFunction (bcBase_Type &base)
	Assign the function to the base of the `BCHandler`. More...

template<>
void	assignFunction (bcBase_Type &base)
	Assign the function to the base of the `BCHandler`. More...

template<>
void	assignFunction (bcBase_Type &base)
	Assign the function to the base of the `BCHandler`. More...

template<>
void	assignFunction (bcBase_Type &base)
	Assign the function to the base of the `BCHandler`. More...

template<>
void	assignFunction (bcBase_Type &base)
	Assign the function to the base of the `BCHandler`. More...

template<>
void	assignFunction (bcBase_Type &base)
	Assign the function to the base of the `BCHandler`. More...

Public Member Functions inherited from BCInterfaceFunction< BcHandlerType, PhysicalSolverType >
	BCInterfaceFunction ()
	Empty Constructor. More...

virtual	~BCInterfaceFunction ()
	Destructor. More...

Private Types
enum	userDefinedFunctions { Sin }

Private Attributes
userDefinedFunctions	M_functionType

parametersContainer_Type	M_parameters

Type definitions
typedef BcHandlerType	bcHandler_Type

typedef PhysicalSolverType	physicalSolver_Type

typedef BCInterfaceFunction< bcHandler_Type, physicalSolver_Type >	function_Type

typedef function_Type::boundaryFunctionTime_Type	boundaryFunctionTime_Type

typedef function_Type::boundaryFunctionTimeTimeStep_Type	boundaryFunctionTimeTimeStep_Type

typedef function_Type::boundaryFunctionTimeSpaceID_Type	boundaryFunctionTimeSpaceID_Type

typedef BCInterfaceData::parametersContainer_Type	parametersContainer_Type

typedef function_Type::bcBase_Type	bcBase_Type

typedef function_Type::data_Type	data_Type

typedef function_Type::dataPtr_Type	dataPtr_Type

Constructors & Destructor
	BCInterfaceFunctionUserDefined ()

virtual	~BCInterfaceFunctionUserDefined ()

Methods
void	assignFunction (bcBase_Type &base)
	Assign the function to the base of the `BCHandler`. More...

Real	functionTime (const Real &t)
	Function of time. More...

Real	functionTimeTimeStep (const Real &t, const Real &timeStep)
	Function of time and time step. More...

Real	functionTimeSpace (const Real &t, const Real &x, const Real &y, const Real &z, const ID &)
	Function of time and space. More...

Real	functionTimeSpaceID (const Real &t, const Real &x, const Real &y, const Real &z, const ID &id)
	Function of time and space with ID. More...

Set Methods
void	setData (const dataPtr_Type &data)
	Set data for boundary conditions. More...

Unimplemented Methods
	BCInterfaceFunctionUserDefined (const BCInterfaceFunctionUserDefined &function)

BCInterfaceFunctionUserDefined &	operator= (const BCInterfaceFunctionUserDefined &function)

Private Methods
boundaryFunctionTime_Type	functionSelectorTime ()
	Get the selected function of time. More...

boundaryFunctionTimeTimeStep_Type	functionSelectorTimeTimeStep ()
	Get the selected function of time and time step. More...

boundaryFunctionTimeSpaceID_Type	functionSelectorTimeSpaceID ()
	Get the selected function of time and space with ID. More...

Real	functionSin (const Real &t, const Real &, const Real &, const Real &, const ID &)
	Sinusoidal function. More...

Additional Inherited Members
Public Types inherited from BCInterfaceFunction< BcHandlerType, PhysicalSolverType >
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

Detailed Description

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

BCInterfaceFunctionUserDefined - User defined functions for BCInterface.

Author: Cristiano Malossi

The BCInterfaceFunctionUserDefined class provides a set of user defined functions to be used by the BCInterface

DETAILS:
The constructor of the class takes a string contains the ID of the boundary condition to impose. The list of available conditions is given through the userDefinedFunctions enum. These are:

Sin

Definition at line 63 of file BCInterfaceFunctionUserDefined.hpp.

Member Typedef Documentation

◆ bcHandler_Type

typedef BcHandlerType bcHandler_Type

Definition at line 70 of file BCInterfaceFunctionUserDefined.hpp.

◆ physicalSolver_Type

typedef PhysicalSolverType physicalSolver_Type

Definition at line 71 of file BCInterfaceFunctionUserDefined.hpp.

◆ function_Type

typedef BCInterfaceFunction< bcHandler_Type, physicalSolver_Type > function_Type

Definition at line 73 of file BCInterfaceFunctionUserDefined.hpp.

◆ boundaryFunctionTime_Type

typedef function_Type::boundaryFunctionTime_Type boundaryFunctionTime_Type

Definition at line 74 of file BCInterfaceFunctionUserDefined.hpp.

◆ boundaryFunctionTimeTimeStep_Type

typedef function_Type::boundaryFunctionTimeTimeStep_Type boundaryFunctionTimeTimeStep_Type

Definition at line 75 of file BCInterfaceFunctionUserDefined.hpp.

◆ boundaryFunctionTimeSpaceID_Type

typedef function_Type::boundaryFunctionTimeSpaceID_Type boundaryFunctionTimeSpaceID_Type

Definition at line 76 of file BCInterfaceFunctionUserDefined.hpp.

◆ parametersContainer_Type

typedef BCInterfaceData::parametersContainer_Type parametersContainer_Type

Definition at line 77 of file BCInterfaceFunctionUserDefined.hpp.

◆ bcBase_Type

typedef function_Type::bcBase_Type bcBase_Type

Definition at line 79 of file BCInterfaceFunctionUserDefined.hpp.

◆ data_Type

typedef function_Type::data_Type data_Type

Definition at line 81 of file BCInterfaceFunctionUserDefined.hpp.

◆ dataPtr_Type

typedef function_Type::dataPtr_Type dataPtr_Type

Definition at line 82 of file BCInterfaceFunctionUserDefined.hpp.

Member Enumeration Documentation

◆ userDefinedFunctions

enum userDefinedFunctions

private

Enumerator
Sin

Definition at line 217 of file BCInterfaceFunctionUserDefined.hpp.

Constructor & Destructor Documentation

◆ BCInterfaceFunctionUserDefined() [1/2]

BCInterfaceFunctionUserDefined ( )

explicit

Definition at line 242 of file BCInterfaceFunctionUserDefined.hpp.

◆ ~BCInterfaceFunctionUserDefined()

virtual ~BCInterfaceFunctionUserDefined ( )

inlinevirtual

Definition at line 92 of file BCInterfaceFunctionUserDefined.hpp.

◆ BCInterfaceFunctionUserDefined() [2/2]

BCInterfaceFunctionUserDefined ( const BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType > & function )

private

Member Function Documentation

◆ assignFunction() [1/15]

void assignFunction ( bcBase_Type & base )

virtual

Assign the function to the base of the BCHandler.

Parameters

base	base of the boundary condition

Implements BCInterfaceFunction< BcHandlerType, PhysicalSolverType >.

◆ functionTime()

Real functionTime ( const Real & t )

inlinevirtual

Function of time.

Parameters

t	time
timeStep	time step

Returns: boundary condition value

Implements BCInterfaceFunction< BcHandlerType, PhysicalSolverType >.

Definition at line 112 of file BCInterfaceFunctionUserDefined.hpp.

◆ functionTimeTimeStep()

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

inlinevirtual

Function of time and time step.

Parameters

t	time
timeStep	time step

Returns: boundary condition value

Implements BCInterfaceFunction< BcHandlerType, PhysicalSolverType >.

Definition at line 123 of file BCInterfaceFunctionUserDefined.hpp.

◆ functionTimeSpace()

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

inlinevirtual

Function of time and space.

Parameters

t	time
x	x coordinate
y	y coordinate
z	z coordinate
id	id of the boundary condition (not used)

Returns: boundary condition value

Implements BCInterfaceFunction< BcHandlerType, PhysicalSolverType >.

Definition at line 137 of file BCInterfaceFunctionUserDefined.hpp.

◆ functionTimeSpaceID()

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

inlinevirtual

Function of time and space with ID.

Parameters

t	time
x	x coordinate
y	y coordinate
z	z coordinate
id	id of the boundary condition

Returns: boundary condition value

Implements BCInterfaceFunction< BcHandlerType, PhysicalSolverType >.

Definition at line 151 of file BCInterfaceFunctionUserDefined.hpp.

◆ setData()

void setData ( const dataPtr_Type & data )

virtual

Set data for boundary conditions.

Parameters

data	boundary condition data loaded from `GetPot` file

Implements BCInterfaceFunction< BcHandlerType, PhysicalSolverType >.

Definition at line 259 of file BCInterfaceFunctionUserDefined.hpp.

◆ operator=()

BCInterfaceFunctionUserDefined& operator= ( const BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType > & function )

private

◆ functionSelectorTime()

BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >::boundaryFunctionTime_Type functionSelectorTime ( )

private

Get the selected function of time.

Returns: boundary function

Definition at line 274 of file BCInterfaceFunctionUserDefined.hpp.

Here is the caller graph for this function:

◆ functionSelectorTimeTimeStep()

BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >::boundaryFunctionTimeTimeStep_Type functionSelectorTimeTimeStep ( )

private

Get the selected function of time and time step.

Returns: boundary function

Definition at line 292 of file BCInterfaceFunctionUserDefined.hpp.

Here is the caller graph for this function:

◆ functionSelectorTimeSpaceID()

BCInterfaceFunctionUserDefined< BcHandlerType, PhysicalSolverType >::boundaryFunctionTimeSpaceID_Type functionSelectorTimeSpaceID ( )

private

Get the selected function of time and space with ID.

Returns: boundary function

Definition at line 310 of file BCInterfaceFunctionUserDefined.hpp.

Here is the caller graph for this function:

◆ functionSin()

Real functionSin	(	const Real &	t,
		const Real &	,
		const Real &	,
		const Real &	,
		const ID &
	)

private

Sinusoidal function.

Parameters

t	time
x	x coordinate
y	y coordinate
z	z coordinate
id	id of the boundary condition (not used)

Returns: boundary condition value

Definition at line 328 of file BCInterfaceFunctionUserDefined.hpp.

◆ assignFunction() [2/15]

void assignFunction ( bcBase_Type & base )

virtual

Assign the function to the base of the BCHandler.

Parameters

base	base of the boundary condition

Implements BCInterfaceFunction< BcHandlerType, PhysicalSolverType >.

Definition at line 48 of file BCInterfaceFunctionUserDefined0D.cpp.

◆ assignFunction() [3/15]

void assignFunction ( bcBase_Type & base )

virtual

Assign the function to the base of the BCHandler.

Parameters

base	base of the boundary condition

Implements BCInterfaceFunction< BcHandlerType, PhysicalSolverType >.

◆ assignFunction() [4/15]

void assignFunction ( bcBase_Type & base )

virtual

Assign the function to the base of the BCHandler.

Parameters

base	base of the boundary condition

Implements BCInterfaceFunction< BcHandlerType, PhysicalSolverType >.

Definition at line 48 of file BCInterfaceFunctionUserDefined1D.cpp.

◆ assignFunction() [5/15]

void assignFunction ( bcBase_Type & base )

virtual

Assign the function to the base of the BCHandler.

Parameters

base	base of the boundary condition

Implements BCInterfaceFunction< BcHandlerType, PhysicalSolverType >.

◆ assignFunction() [6/15]

void assignFunction ( bcBase_Type & base )

virtual

Assign the function to the base of the BCHandler.

Parameters

base	base of the boundary condition

Implements BCInterfaceFunction< BcHandlerType, PhysicalSolverType >.

Definition at line 49 of file BCInterfaceFunctionUserDefinedEmpty3D.cpp.

◆ assignFunction() [7/15]

void assignFunction ( bcBase_Type & base )

virtual

Assign the function to the base of the BCHandler.

Parameters

base	base of the boundary condition

Implements BCInterfaceFunction< BcHandlerType, PhysicalSolverType >.

◆ assignFunction() [8/15]

void assignFunction ( bcBase_Type & base )

virtual

Assign the function to the base of the BCHandler.

Parameters

base	base of the boundary condition

Implements BCInterfaceFunction< BcHandlerType, PhysicalSolverType >.

Definition at line 48 of file BCInterfaceFunctionUserDefinedFluid3D.cpp.

◆ assignFunction() [9/15]

void assignFunction ( bcBase_Type & base )

virtual

Assign the function to the base of the BCHandler.

Parameters

base	base of the boundary condition

Implements BCInterfaceFunction< BcHandlerType, PhysicalSolverType >.

Definition at line 55 of file BCInterfaceFunctionUserDefinedFluid3D.cpp.

◆ assignFunction() [10/15]

void assignFunction ( bcBase_Type & base )

virtual

Assign the function to the base of the BCHandler.

Parameters

base	base of the boundary condition

Implements BCInterfaceFunction< BcHandlerType, PhysicalSolverType >.

◆ assignFunction() [11/15]

void assignFunction ( bcBase_Type & base )

virtual

Assign the function to the base of the BCHandler.

Parameters

base	base of the boundary condition

Implements BCInterfaceFunction< BcHandlerType, PhysicalSolverType >.

◆ assignFunction() [12/15]

void assignFunction ( bcBase_Type & base )

virtual

Assign the function to the base of the BCHandler.

Parameters

base	base of the boundary condition

Implements BCInterfaceFunction< BcHandlerType, PhysicalSolverType >.

Definition at line 48 of file BCInterfaceFunctionUserDefinedFSI3D.cpp.

◆ assignFunction() [13/15]

void assignFunction ( bcBase_Type & base )

virtual

Assign the function to the base of the BCHandler.

Parameters

base	base of the boundary condition

Implements BCInterfaceFunction< BcHandlerType, PhysicalSolverType >.

◆ assignFunction() [14/15]

void assignFunction ( bcBase_Type & base )

virtual

Assign the function to the base of the BCHandler.

Parameters

base	base of the boundary condition

Implements BCInterfaceFunction< BcHandlerType, PhysicalSolverType >.

Definition at line 48 of file BCInterfaceFunctionUserDefinedSolid3D.cpp.

◆ assignFunction() [15/15]

void assignFunction ( bcBase_Type & base )

virtual

Assign the function to the base of the BCHandler.

Parameters

base	base of the boundary condition

Implements BCInterfaceFunction< BcHandlerType, PhysicalSolverType >.

Field Documentation

◆ M_functionType

userDefinedFunctions M_functionType

private

Definition at line 222 of file BCInterfaceFunctionUserDefined.hpp.

◆ M_parameters

parametersContainer_Type M_parameters

private

Definition at line 224 of file BCInterfaceFunctionUserDefined.hpp.

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

BCInterfaceFunctionUserDefined.hpp

Public Member Functions

Private Types

Private Attributes

Type definitions

Constructors & Destructor

Methods

Set Methods

Unimplemented Methods

Private Methods

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ bcHandler_Type

◆ physicalSolver_Type

◆ function_Type

◆ boundaryFunctionTime_Type

◆ boundaryFunctionTimeTimeStep_Type

◆ boundaryFunctionTimeSpaceID_Type

◆ parametersContainer_Type

◆ bcBase_Type

◆ data_Type

◆ dataPtr_Type

Member Enumeration Documentation

◆ userDefinedFunctions

Constructor & Destructor Documentation

◆ BCInterfaceFunctionUserDefined() [1/2]

◆ ~BCInterfaceFunctionUserDefined()

◆ BCInterfaceFunctionUserDefined() [2/2]

Member Function Documentation

◆ assignFunction() [1/15]

◆ functionTime()

◆ functionTimeTimeStep()

◆ functionTimeSpace()

◆ functionTimeSpaceID()

◆ setData()

◆ operator=()

◆ functionSelectorTime()

◆ functionSelectorTimeTimeStep()

◆ functionSelectorTimeSpaceID()

◆ functionSin()

◆ assignFunction() [2/15]

◆ assignFunction() [3/15]

◆ assignFunction() [4/15]

◆ assignFunction() [5/15]

◆ assignFunction() [6/15]

◆ assignFunction() [7/15]

◆ assignFunction() [8/15]

◆ assignFunction() [9/15]

◆ assignFunction() [10/15]

◆ assignFunction() [11/15]

◆ assignFunction() [12/15]

◆ assignFunction() [13/15]

◆ assignFunction() [14/15]

◆ assignFunction() [15/15]

Field Documentation

◆ M_functionType

◆ M_parameters

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