InflowBoundaryModel< CloudType > Class Template Reference

Templated inflow boundary model class. More...

#include <InflowBoundaryModel.H>

Inheritance diagram for InflowBoundaryModel< CloudType >:

Public Member Functions
	TypeName ("InflowBoundaryModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, InflowBoundaryModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
	Declare runtime constructor selection table.
	InflowBoundaryModel (CloudType &owner)
	Construct null from owner.
	InflowBoundaryModel (const dictionary &dict, CloudType &owner, const word &type)
	Construct from dictionary.
virtual	~InflowBoundaryModel ()
	Destructor.
const CloudType &	owner () const
	Return const access the owner cloud object.
CloudType &	owner ()
	Return non-const access the owner cloud object for manipulation.
const dictionary &	dict () const
	Return the owner cloud dictionary.
const dictionary &	coeffDict () const
	Return the coefficients dictionary.
virtual void	autoMap (const mapPolyMesh &)
	Remap the particles to the correct cells following mesh change.
virtual void	inflow ()=0
	Introduce particles.

Static Public Member Functions
static autoPtr< InflowBoundaryModel< CloudType > >	New (const dictionary &dict, CloudType &owner)
	Selector.

Detailed Description

template<class CloudType>
class Foam::InflowBoundaryModel< CloudType >

Templated inflow boundary model class.

Source files

• InflowBoundaryModel.H
• InflowBoundaryModel.C
• InflowBoundaryModelNew.C

Definition at line 51 of file InflowBoundaryModel.H.

Constructor & Destructor Documentation

InflowBoundaryModel() [1/2]

template<class CloudType>

InflowBoundaryModel

(

CloudType &

owner

)

Construct null from owner.

Definition at line 26 of file InflowBoundaryModel.C.

References owner().

Referenced by declareRunTimeSelectionTable(), FreeStream< CloudType >::FreeStream(), and NoInflow< CloudType >::NoInflow().

Here is the call graph for this function:

Here is the caller graph for this function:

InflowBoundaryModel() [2/2]

template<class CloudType>

InflowBoundaryModel	(	const dictionary &	dict,
		CloudType &	owner,
		const word &	type )

Construct from dictionary.

Definition at line 35 of file InflowBoundaryModel.C.

References dict(), and owner().

Here is the call graph for this function:

~InflowBoundaryModel()

template<class CloudType>

~InflowBoundaryModel ( )

virtual

Destructor.

Definition at line 51 of file InflowBoundaryModel.C.

Member Function Documentation

TypeName()

template<class CloudType>

TypeName

(

"InflowBoundaryModel< CloudType >"

)

Runtime type information.

declareRunTimeSelectionTable()

template<class CloudType>

declareRunTimeSelectionTable	(	autoPtr	,
		InflowBoundaryModel< CloudType >	,
		dictionary	,
		(const dictionary &dict, CloudType &owner)	,
		(dict, owner)	)

Declare runtime constructor selection table.

References dict(), InflowBoundaryModel(), and owner().

Here is the call graph for this function:

New()

template<class CloudType>

Foam::autoPtr< Foam::InflowBoundaryModel< CloudType > > New ( const dictionary & dict, CloudType & owner )

static

Selector.

Definition at line 28 of file InflowBoundaryModelNew.C.

References dict(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, and owner().

Here is the call graph for this function:

owner() [1/2]

template<class CloudType>

const CloudType & owner ( ) const

inline

Return const access the owner cloud object.

Definition at line 58 of file InflowBoundaryModel.C.

Referenced by FreeStream< CloudType >::autoMap(), declareRunTimeSelectionTable(), FreeStream< CloudType >::inflow(), InflowBoundaryModel(), InflowBoundaryModel(), and New().

Here is the caller graph for this function:

owner() [2/2]

template<class CloudType>

CloudType & owner ( )

inline

Return non-const access the owner cloud object for manipulation.

Definition at line 65 of file InflowBoundaryModel.C.

dict()

template<class CloudType>

const Foam::dictionary & dict ( ) const

inline

Return the owner cloud dictionary.

Definition at line 72 of file InflowBoundaryModel.C.

Referenced by declareRunTimeSelectionTable(), FreeStream< CloudType >::FreeStream(), InflowBoundaryModel(), New(), NoInflow< CloudType >::NoInflow(), FreeStream< CloudType >::TypeName(), and NoInflow< CloudType >::TypeName().

Here is the caller graph for this function:

coeffDict()

template<class CloudType>

const Foam::dictionary & coeffDict ( ) const

inline

Return the coefficients dictionary.

Definition at line 79 of file InflowBoundaryModel.C.

Referenced by FreeStream< CloudType >::FreeStream().

Here is the caller graph for this function:

autoMap()

template<class CloudType>

virtual void autoMap ( const mapPolyMesh & )

inlinevirtual

Remap the particles to the correct cells following mesh change.

Reimplemented in FreeStream< CloudType >.

Definition at line 153 of file InflowBoundaryModel.H.

inflow()

template<class CloudType>

virtual void inflow ( )

pure virtual

Introduce particles.

Implemented in FreeStream< CloudType >, and NoInflow< CloudType >.

---

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

• src/lagrangian/DSMC/clouds/Templates/DSMCCloud/DSMCCloud.H
• src/lagrangian/DSMC/submodels/InflowBoundaryModel/InflowBoundaryModel/InflowBoundaryModel.H
• src/lagrangian/DSMC/submodels/InflowBoundaryModel/InflowBoundaryModel/InflowBoundaryModel.C
• src/lagrangian/DSMC/submodels/InflowBoundaryModel/InflowBoundaryModel/InflowBoundaryModelNew.C