ZeroDimensionalFunction Class Reference

ZeroDimensionalFunction - A boundary conditions function for zero-dimensional models. More...

#include <ZeroDimensionalFunction.hpp>

Collaboration diagram for ZeroDimensionalFunction:

Private Attributes
function_Type	M_function

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

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

Operators
ZeroDimensionalFunction &	operator= (const ZeroDimensionalFunction &bcFunction)
	Operator=. More...
Real	operator() (const Real &time) 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

ZeroDimensionalFunction - A boundary conditions function for zero-dimensional models.

Author

Cristiano Malossi

This simple class handles the boundary condition functions for zero-dimensional models.

Definition at line 51 of file ZeroDimensionalFunction.hpp.

Member Typedef Documentation

function_Type

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

Type definition for the 0D boundary function.

Definition at line 60 of file ZeroDimensionalFunction.hpp.

Constructor & Destructor Documentation

ZeroDimensionalFunction() [1/3]

ZeroDimensionalFunction ( )

inlineexplicit

Empty Constructor.

Definition at line 69 of file ZeroDimensionalFunction.hpp.

Here is the caller graph for this function:

ZeroDimensionalFunction() [2/3]

ZeroDimensionalFunction ( const function_Type &  function )

inlineexplicit

Constructor by function.

Parameters

function

the user defined function

Definition at line 75 of file ZeroDimensionalFunction.hpp.

ZeroDimensionalFunction() [3/3]

ZeroDimensionalFunction ( const ZeroDimensionalFunction &  bcFunction )

inline

Copy constructor.

Parameters

bcFunction

ZeroDimensionalFunction

Definition at line 81 of file ZeroDimensionalFunction.hpp.

Here is the caller graph for this function:

~ZeroDimensionalFunction()

virtual ~ZeroDimensionalFunction ( )

inlinevirtual

Destructor.

Definition at line 84 of file ZeroDimensionalFunction.hpp.

Member Function Documentation

operator=()

ZeroDimensionalFunction& operator= ( const ZeroDimensionalFunction &  bcFunction )

inline

Operator=.

Parameters

bcFunction

ZeroDimensionalFunction

Returns

reference to a copy of the class

Definition at line 97 of file ZeroDimensionalFunction.hpp.

Here is the caller graph for this function:

operator()()

Real operator() ( const Real &  time ) const

inline

Operator()

Evaluate the function.

Parameters

time	the current time.
timeStep	the time step.

Returns

the value of the function.

Definition at line 115 of file ZeroDimensionalFunction.hpp.

Here is the caller graph for this function:

setFunction()

void setFunction ( const function_Type &  function )

inline

Set the function.

Parameters

function

the user defined function

Definition at line 130 of file ZeroDimensionalFunction.hpp.

function()

const function_Type& function ( ) const

inline

Get the function.

Returns

the user defined function

Definition at line 145 of file ZeroDimensionalFunction.hpp.

Field Documentation

M_function

function_Type M_function

private

Definition at line 154 of file ZeroDimensionalFunction.hpp.

---

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

• ZeroDimensionalFunction.hpp