BCInterfaceFunctionSolverDefined< OneDFSIBCHandler, OneDFSISolver > Class Template Reference

BCInterfaceFunctionSolverDefined - Template specialization of BCInterfaceFunctionSolverDefined for 1D problems. More...

#include <BCInterfaceFunctionSolverDefined1D.hpp>

Collaboration diagram for BCInterfaceFunctionSolverDefined< OneDFSIBCHandler, OneDFSISolver >:

Private Types
enum	solverDefinedFunctions { Riemann, Compatibility, Absorbing, Resistance }

Private Attributes
solverDefinedFunctions	M_defaultFunction
bcFunctionSolverDefinedPtr_Type	M_function

Type definitions
typedef OneDFSIBCHandler	bcHandler_Type
typedef OneDFSISolver	physicalSolver_Type
typedef std::shared_ptr< physicalSolver_Type >	physicalSolverPtr_Type
typedef bcHandler_Type::bc_Type	bc_Type
typedef bc_Type::bcFunctionSolverDefinedPtr_Type	bcFunctionSolverDefinedPtr_Type
typedef bc_Type::vectorPtrContainer_Type	vectorPtrContainer_Type
typedef BCInterfaceData1D	data_Type
typedef std::shared_ptr< data_Type >	dataPtr_Type
typedef bc_Type::fluxPtr_Type	fluxPtr_Type
typedef bc_Type::sourcePtr_Type	sourcePtr_Type
typedef bc_Type::solutionPtr_Type	solutionPtr_Type

Constructors & Destructor
	BCInterfaceFunctionSolverDefined ()
	Constructor. More...
virtual	~BCInterfaceFunctionSolverDefined ()
	Destructor. More...

Methods
void	assignFunction (OneDFSIFunction &base)
	Assign the function to the base. More...
void	updatePhysicalSolverVariables ()
	Update the solver variables. More...

Set Methods
void	setData (const dataPtr_Type &data)
	Set data. More...
void	setFluxSource (const fluxPtr_Type &flux, const sourcePtr_Type &source)
	Set flux and source. More...
void	setSolution (const solutionPtr_Type &solution)
	Set solution. More...
void	setPhysicalSolver (const physicalSolverPtr_Type &)
	Set the physical solver. More...

Get methods
baseContainer_Type	baseType () const
	Detect the correct base type. More...

Unimplemented Methods
	BCInterfaceFunctionSolverDefined (const BCInterfaceFunctionSolverDefined &function)
BCInterfaceFunctionSolverDefined &	operator= (const BCInterfaceFunctionSolverDefined &function)

Detailed Description

template<>
class LifeV::BCInterfaceFunctionSolverDefined< OneDFSIBCHandler, OneDFSISolver >

BCInterfaceFunctionSolverDefined - Template specialization of BCInterfaceFunctionSolverDefined for 1D problems.

Author

Cristiano Malossi

The BCInterfaceFunctionSolverDefined class provides a general interface between the BCInterface1D and the solver defined boundary conditions of the OneDFSISolver.

DETAILS:
The list of available conditions is described by the solverDefinedFunctions enum type.

They are:

1. Riemann;
2. Compatibility;
3. Absorbing;
4. Resistance.

Definition at line 69 of file BCInterfaceFunctionSolverDefined1D.hpp.

Member Typedef Documentation

bcHandler_Type

typedef OneDFSIBCHandler bcHandler_Type

Definition at line 76 of file BCInterfaceFunctionSolverDefined1D.hpp.

physicalSolver_Type

typedef OneDFSISolver physicalSolver_Type

Definition at line 77 of file BCInterfaceFunctionSolverDefined1D.hpp.

physicalSolverPtr_Type

typedef std::shared_ptr< physicalSolver_Type > physicalSolverPtr_Type

Definition at line 78 of file BCInterfaceFunctionSolverDefined1D.hpp.

bc_Type

typedef bcHandler_Type::bc_Type bc_Type

Definition at line 80 of file BCInterfaceFunctionSolverDefined1D.hpp.

bcFunctionSolverDefinedPtr_Type

typedef bc_Type::bcFunctionSolverDefinedPtr_Type bcFunctionSolverDefinedPtr_Type

Definition at line 81 of file BCInterfaceFunctionSolverDefined1D.hpp.

vectorPtrContainer_Type

typedef bc_Type::vectorPtrContainer_Type vectorPtrContainer_Type

Definition at line 83 of file BCInterfaceFunctionSolverDefined1D.hpp.

data_Type

typedef BCInterfaceData1D data_Type

Definition at line 85 of file BCInterfaceFunctionSolverDefined1D.hpp.

dataPtr_Type

typedef std::shared_ptr< data_Type > dataPtr_Type

Definition at line 86 of file BCInterfaceFunctionSolverDefined1D.hpp.

fluxPtr_Type

typedef bc_Type::fluxPtr_Type fluxPtr_Type

Definition at line 88 of file BCInterfaceFunctionSolverDefined1D.hpp.

sourcePtr_Type

typedef bc_Type::sourcePtr_Type sourcePtr_Type

Definition at line 89 of file BCInterfaceFunctionSolverDefined1D.hpp.

solutionPtr_Type

typedef bc_Type::solutionPtr_Type solutionPtr_Type

Definition at line 90 of file BCInterfaceFunctionSolverDefined1D.hpp.

Member Enumeration Documentation

solverDefinedFunctions

enum solverDefinedFunctions

private

Enumerator
Riemann
Compatibility
Absorbing
Resistance

Definition at line 184 of file BCInterfaceFunctionSolverDefined1D.hpp.

Constructor & Destructor Documentation

BCInterfaceFunctionSolverDefined() [1/2]

BCInterfaceFunctionSolverDefined ( )

explicit

Constructor.

Definition at line 45 of file BCInterfaceFunctionSolverDefined1D.cpp.

~BCInterfaceFunctionSolverDefined()

virtual ~BCInterfaceFunctionSolverDefined ( )

inlinevirtual

Destructor.

Definition at line 102 of file BCInterfaceFunctionSolverDefined1D.hpp.

BCInterfaceFunctionSolverDefined() [2/2]

BCInterfaceFunctionSolverDefined ( const BCInterfaceFunctionSolverDefined< OneDFSIBCHandler, OneDFSISolver > &  function )

private

Member Function Documentation

assignFunction()

void assignFunction

(

OneDFSIFunction &

base

)

Assign the function to the base.

Parameters

base	base of the bc

Definition at line 60 of file BCInterfaceFunctionSolverDefined1D.cpp.

updatePhysicalSolverVariables()

void updatePhysicalSolverVariables ( )

inline

Update the solver variables.

Definition at line 117 of file BCInterfaceFunctionSolverDefined1D.hpp.

setData()

void setData

(

const dataPtr_Type &

data

)

Set data.

Parameters

data	BC data loaded from GetPot file

Definition at line 98 of file BCInterfaceFunctionSolverDefined1D.cpp.

setFluxSource()

void setFluxSource ( const fluxPtr_Type &  flux, const sourcePtr_Type &  source  )

inline

Set flux and source.

Parameters

flux	flux object of the 1D model
source	source object of the 1D model

Definition at line 136 of file BCInterfaceFunctionSolverDefined1D.hpp.

setSolution()

void setSolution ( const solutionPtr_Type &  solution )

inline

Set solution.

Parameters

solution

solution container of the 1D model

Definition at line 145 of file BCInterfaceFunctionSolverDefined1D.hpp.

setPhysicalSolver()

void setPhysicalSolver ( const physicalSolverPtr_Type &  )

inline

Set the physical solver.

Parameters

physicalSolver

physical solver

Definition at line 154 of file BCInterfaceFunctionSolverDefined1D.hpp.

baseType()

baseContainer_Type baseType ( ) const

inline

Detect the correct base type.

Parameters

bcBaseType

the type of the base

Definition at line 166 of file BCInterfaceFunctionSolverDefined1D.hpp.

operator=()

BCInterfaceFunctionSolverDefined& operator= ( const BCInterfaceFunctionSolverDefined< OneDFSIBCHandler, OneDFSISolver > &  function )

private

Field Documentation

M_defaultFunction

solverDefinedFunctions M_defaultFunction

private

Definition at line 192 of file BCInterfaceFunctionSolverDefined1D.hpp.

M_function

bcFunctionSolverDefinedPtr_Type M_function

private

Definition at line 193 of file BCInterfaceFunctionSolverDefined1D.hpp.

---

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

• BCInterfaceFunctionSolverDefined1D.hpp
• BCInterfaceFunctionSolverDefined1D.cpp