OneDFSIFunction Class Reference

OneDFSIFunction - Base class for 1D BC Functions. More...

#include <OneDFSIFunction.hpp>

Collaboration diagram for OneDFSIFunction:

Private Attributes
function_Type	M_function

Type definitions and Enumerators
typedef std::function< Real(const Real &, const Real &) >	function_Type
	Type definition for the 1D boundary function. More...

Constructors & Destructor
	OneDFSIFunction ()
	Empty Constructor. More...
	OneDFSIFunction (const function_Type &function)
	Constructor by function. More...
	OneDFSIFunction (const OneDFSIFunction &bcFunction)
	Copy constructor. More...
virtual	~OneDFSIFunction ()
	Destructor. More...

Operators
OneDFSIFunction &	operator= (const OneDFSIFunction &bcFunction)
	Operator=. More...
Real	operator() (const Real &time, const Real &timeStep=0.) const
	Operator() More...

Set Methods
void	setFunction (const function_Type &function)
	Set the function. More...

Get Methods
const function_Type &	function () const
	Get the function. More...

Detailed Description

OneDFSIFunction - Base class for 1D BC Functions.

Author

Lucia Mirabella, Tiziano Passerini, Cristiano Malossi

See also

Equations and networks of 1-D models [7]

Geometrical multiscale coupling of 1-D models [12] [13]

The 1D boundary condition function is evaluated as a function of the current time and of the time step.

Definition at line 59 of file OneDFSIFunction.hpp.

Member Typedef Documentation

function_Type

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

Type definition for the 1D boundary function.

Definition at line 68 of file OneDFSIFunction.hpp.

Constructor & Destructor Documentation

OneDFSIFunction() [1/3]

OneDFSIFunction ( )

inlineexplicit

Empty Constructor.

Definition at line 77 of file OneDFSIFunction.hpp.

Here is the caller graph for this function:

OneDFSIFunction() [2/3]

OneDFSIFunction ( const function_Type &  function )

inlineexplicit

Constructor by function.

Parameters

function

the user defined function

Definition at line 83 of file OneDFSIFunction.hpp.

OneDFSIFunction() [3/3]

OneDFSIFunction ( const OneDFSIFunction &  bcFunction )

inline

Copy constructor.

Parameters

bcFunction

OneDFSIFunction

Definition at line 89 of file OneDFSIFunction.hpp.

~OneDFSIFunction()

virtual ~OneDFSIFunction ( )

inlinevirtual

Destructor.

Definition at line 92 of file OneDFSIFunction.hpp.

Member Function Documentation

operator=()

OneDFSIFunction& operator= ( const OneDFSIFunction &  bcFunction )

inline

Operator=.

Parameters

bcFunction

OneDFSIFunction

Returns

reference to a copy of the class

Definition at line 105 of file OneDFSIFunction.hpp.

operator()()

Real operator() ( const Real &  time, const Real &  timeStep = 0.  ) const

inline

Operator()

Evaluate the function.

Parameters

time	the current time.
timeStep	the time step.

Returns

the value of the function.

Definition at line 123 of file OneDFSIFunction.hpp.

setFunction()

void setFunction ( const function_Type &  function )

inline

Set the function.

Parameters

function

the user defined function

Definition at line 138 of file OneDFSIFunction.hpp.

function()

const function_Type& function ( ) const

inline

Get the function.

Returns

the user defined function

Definition at line 153 of file OneDFSIFunction.hpp.

Field Documentation

M_function

function_Type M_function

private

Definition at line 162 of file OneDFSIFunction.hpp.

---

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

• OneDFSIFunction.hpp