BCFunctionUDepBase - class that holds the function used for prescribing boundary conditions. More...

#include <BCFunction.hpp>

Inheritance diagram for BCFunctionDirectional:

Collaboration diagram for BCFunctionDirectional:

Private Attributes
function_Type	M_userDefinedVersorsFunction
	user defined function returning versors along which the essential boundary condition will be prescribed More...

Public Types
typedef BCFunctionBase::function_Type	function_Type

Constructors & Destructor
	BCFunctionDirectional ()
	Default constructor. More...

	BCFunctionDirectional (const function_Type &userDefinedFunctional, const function_Type &userDefinedVersorsFunction)
	Constructing from user defined functions. More...

	BCFunctionDirectional (const BCFunctionDirectional &bcFunctionDirectional)
	Copy Constructor. More...

virtual	~BCFunctionDirectional ()

Operators
BCFunctionDirectional &	operator= (const BCFunctionDirectional &bcFunctionDirectional)
	Assignment operator. More...

Methods
Real	vectFct (const Real &t, const Real &x, const Real &y, const Real &z, const ID &component) const
	Evaluate the versors' function. More...

Set Methods
void	setFunctions_Directional (const function_Type &userDefinedFunctional, const function_Type &userDefinedVersorsFunction)
	Set the functions. More...

Get Methods
const function_Type &	Functions_Directional () const
	Get the versors' function. More...

Additional Inherited Members
Public Types inherited from BCFunctionBase
typedef std::function< Real(const Real &, const Real &, const Real &, const Real &, const ID &) >	function_Type

typedef std::shared_ptr< BCFunctionBase >	BCFunctionBasePtr_Type

Public Member Functions inherited from BCFunctionBase
	BCFunctionBase ()
	Empty Constructor. More...

	BCFunctionBase (function_Type userDefinedFunction)
	Constructor for a user defined function. More...

	BCFunctionBase (const BCFunctionBase &bcFunctionBase)
	Copy Constructor. More...

virtual	~BCFunctionBase ()
	Destructor. More...

virtual BCFunctionBase &	operator= (const BCFunctionBase &bcFunctionBase)
	Assignment Operator. More...

Real	operator() (const Real &t, const Real &x, const Real &y, const Real &z, const ID &component) const
	Overloading function operator by calling M_userDefinedFunction. More...

void	setFunction (function_Type userDefinedFunction)
	Set the user defined function. More...

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

virtual BCFunctionBasePtr_Type	clone () const
	Clone the current object. More...

Protected Attributes inherited from BCFunctionBase
function_Type	M_userDefinedFunction
	user defined function More...

Detailed Description

BCFunctionUDepBase - class that holds the function used for prescribing boundary conditions.

Author: Miguel Fernandez

This class holds the function used for prescribing Essential boundary conditions along a direction.

The data functions given by the user must have the following signature

Real f(const Real& t, const Real& x, const Real& y, const Real& z, const ID& component)

We want to prescribe < u, d > = f on part of the boundary. Here < u, d > is the projection of the solution u along the versor d, which is a given function

Functions f and d are set using the correct constructor or using setFunction_Directional(f,d).

To get the function d use Function_Directional(), to evaluate it use the method vectFct(...).
To get the function f use getFunction(), to evaluate it use the operator().

Class (STL functor) that holds the user defined fonctions for a directional Dirichlet bc

The data funcitions given by the user must have the following declaration Real g(const Real& time, const Real& x, const Real& y, const Real& z, const ID& icomp)

Definition at line 683 of file BCFunction.hpp.

Member Typedef Documentation

◆ function_Type

typedef BCFunctionBase::function_Type function_Type

Definition at line 692 of file BCFunction.hpp.

Constructor & Destructor Documentation

◆ BCFunctionDirectional() [1/3]

BCFunctionDirectional ( )

inline

Default constructor.

The user must supply a function by calling setFunction_Directional(..)

Definition at line 703 of file BCFunction.hpp.

◆ BCFunctionDirectional() [2/3]

BCFunctionDirectional	(	const function_Type &	userDefinedFunctional,
		const function_Type &	userDefinedVersorsFunction
	)

Constructing from user defined functions.

Parameters

userDefinedFunctional	The user defined function
userDefinedVersorsFunction	user defined function for returning versors along which the essential boundary condition will be prescribed

Definition at line 271 of file BCFunction.cpp.

◆ BCFunctionDirectional() [3/3]

BCFunctionDirectional ( const BCFunctionDirectional & bcFunctionDirectional )

Copy Constructor.

Parameters

bcFunctionDirectional The BCFunctionDirectional

Definition at line 264 of file BCFunction.cpp.

Here is the caller graph for this function:

◆ ~BCFunctionDirectional()

virtual ~BCFunctionDirectional ( )

inlinevirtual

Definition at line 719 of file BCFunction.hpp.

Member Function Documentation

◆ operator=()

BCFunctionDirectional & operator= ( const BCFunctionDirectional & bcFunctionDirectional )

Assignment operator.

Parameters

bdFunctionDirectional The BCFunctionDirectional object

Returns: Reference to a new BCFunctionDirectional object which is a copy of bcFunctionDirectional

Definition at line 284 of file BCFunction.cpp.

◆ vectFct()

Real vectFct	(	const Real &	t,
		const Real &	x,
		const Real &	y,
		const Real &	z,
		const ID &	component
	)		const

inline

Evaluate the versors' function.

Parameters

t	Time
x	Coordinate
y	Coordinate
z	Coordinate
component	The component of the vectors function

Returns: The selected component of the versors' function evaluated in (t,x,y,z)

Definition at line 751 of file BCFunction.hpp.

Here is the caller graph for this function:

◆ setFunctions_Directional()

void setFunctions_Directional	(	const function_Type &	userDefinedFunctional,
		const function_Type &	userDefinedVersorsFunction
	)

Set the functions.

Parameters

userDefinedFunctional	User defined function
userDefinedVersorsFunction	User defined function for returning versors along which the essential boundary condition will be prescribed

Definition at line 299 of file BCFunction.cpp.

◆ Functions_Directional()

const function_Type& Functions_Directional ( ) const

inline

Get the versors' function.

Returns: User defined function for returning versors along which the essential boundary condition will be prescribed

Definition at line 783 of file BCFunction.hpp.

Field Documentation

◆ M_userDefinedVersorsFunction

function_Type M_userDefinedVersorsFunction

private

user defined function returning versors along which the essential boundary condition will be prescribed

Definition at line 793 of file BCFunction.hpp.

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

Private Attributes

Public Types

Constructors & Destructor

Operators

Methods

Set Methods

Get Methods

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ function_Type

Constructor & Destructor Documentation

◆ BCFunctionDirectional() [1/3]

◆ BCFunctionDirectional() [2/3]

◆ BCFunctionDirectional() [3/3]

◆ ~BCFunctionDirectional()

Member Function Documentation

◆ operator=()

◆ vectFct()

◆ setFunctions_Directional()

◆ Functions_Directional()

Field Documentation

◆ M_userDefinedVersorsFunction