Templated wall surface film model class. More...

Inheritance diagram for SurfaceFilmModel< CloudType >:

[legend]

Collaboration diagram for SurfaceFilmModel< CloudType >:

[legend]

Public Member Functions
	TypeName ("surfaceFilm")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, SurfaceFilmModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
	Declare runtime constructor selection table. More...

	SurfaceFilmModel (CloudType &owner)
	Construct null from owner. More...

	SurfaceFilmModel (const dictionary &dict, CloudType &owner, const word &type)
	Construct from components. More...

	SurfaceFilmModel (const SurfaceFilmModel< CloudType > &sfm)
	Construct copy. More...

virtual autoPtr< SurfaceFilmModel< CloudType > >	clone () const =0
	Construct and return a clone. More...

virtual	~SurfaceFilmModel ()
	Destructor. More...

const dimensionedVector &	g () const
	Return gravitational acceleration constant. More...

label	nParcelsTransferred () const
	Return const access to the number of parcels transferred to the. More...

label &	nParcelsTransferred ()
	Return non-const access to the number of parcels transferred to. More...

label	nParcelsInjected () const
	Return const access to the number of parcels injected from the. More...

label &	nParcelsInjected ()
	Return non-const access to the number of parcels injected from. More...

virtual bool	transferParcel (parcelType &p, const polyPatch &pp, bool &keepParticle)=0
	Transfer parcel from cloud to surface film. More...

template<class TrackCloudType >
void	inject (TrackCloudType &cloud)
	Inject parcels into the cloud. More...

virtual void	info (Ostream &os)
	Write surface film info to stream. More...

Public Member Functions inherited from CloudSubModelBase< CloudType >
	CloudSubModelBase (CloudType &owner)
	Construct null from owner cloud. More...

	CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from owner cloud without name. More...

	CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from owner cloud with name. More...

	CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
	Copy constructor. More...

virtual	~CloudSubModelBase ()
	Destructor. More...

const CloudType &	owner () const
	Return const access to the owner cloud. More...

virtual bool	writeTime () const
	Flag to indicate when to write a property. More...

CloudType &	owner ()
	Return non-const access to the owner cloud for manipulation. More...

virtual void	write (Ostream &os) const
	Write. More...

Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	Construct null. More...

	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from components without name. More...

	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from components with name. More...

	subModelBase (const subModelBase &smb)
	Copy constructor. More...

virtual	~subModelBase ()
	Destructor. More...

const word &	modelName () const
	Return const access to the name of the sub-model. More...

const dictionary &	dict () const
	Return const access to the cloud dictionary. More...

const word &	baseName () const
	Return const access to the base name of the sub-model. More...

const word &	modelType () const
	Return const access to the sub-model type. More...

const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary. More...

const dictionary &	properties () const
	Return const access to the properties dictionary. More...

virtual bool	defaultCoeffs (const bool printMsg) const
	Returns true if defaultCoeffs is true and outputs on printMsg. More...

virtual void	cacheFields (const bool store)
	Cache dependent sub-model fields. More...

template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
	Retrieve generic property from the base model. More...

template<class Type >
void	getBaseProperty (const word &entryName, Type &value) const
	Retrieve generic property from the base model. More...

template<class Type >
void	setBaseProperty (const word &entryName, const Type &value)
	Add generic property to the base model. More...

template<class Type >
void	getModelProperty (const word &entryName, Type &value) const
	Retrieve generic property from the sub-model. More...

template<class Type >
Type	getModelProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
	Retrieve generic property from the sub-model. More...

template<class Type >
void	setModelProperty (const word &entryName, const Type &value)
	Add generic property to the sub-model. More...

void	operator= (const subModelBase &)=delete
	Disallow default bitwise assignment. More...

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

Protected Types
typedef CloudType::parcelType	parcelType
	Convenience typedef to the cloud's parcel type. More...

Protected Member Functions
virtual const labelList &	filmPatches () const =0
	Return list of film patches. More...

virtual void	cacheFilmFields (const label filmi)=0
	Cache the film fields in preparation for injection. More...

virtual void	setParcelProperties (parcelType &p, const label filmFacei) const =0
	Set the individual parcel properties. More...

Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line. More...

Protected Attributes
const dimensionedVector &	g_
	Gravitational acceleration constant. More...

label	ejectedParcelType_
	Ejected parcel type label - id assigned to identify parcel for. More...

scalarField	massParcelPatch_
	Parcel mass / patch face. More...

scalarField	diameterParcelPatch_
	Parcel diameter / patch face. More...

scalarField	deltaFilmPatch_
	Film height of all film patches / patch face. More...

label	nParcelsTransferred_
	Number of parcels transferred to the film model. More...

label	nParcelsInjected_
	Number of parcels injected from the film model. More...

Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_
	Reference to the cloud. More...

Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model. More...

dictionary &	properties_
	Reference to properties dictionary e.g. for restart. More...

const dictionary	dict_
	Copy of dictionary used during construction. More...

const word	baseName_
	Name of the sub-model base class. More...

const word	modelType_
	Type of the sub-model. More...

const dictionary	coeffDict_
	Coefficients dictionary. More...

Additional Inherited Members
Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType
	Type of cloud this model was instantiated for. More...

Detailed Description

template<class CloudType>
class Foam::SurfaceFilmModel< CloudType >

Templated wall surface film model class.

Source files

Definition at line 53 of file SurfaceFilmModel.H.

Member Typedef Documentation

◆ parcelType

typedef CloudType::parcelType parcelType

protected

Convenience typedef to the cloud's parcel type.

Definition at line 62 of file SurfaceFilmModel.H.

Constructor & Destructor Documentation

◆ SurfaceFilmModel() [1/3]

SurfaceFilmModel ( CloudType & owner )

Construct null from owner.

Definition at line 33 of file SurfaceFilmModel.C.

◆ SurfaceFilmModel() [2/3]

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

Construct from components.

Definition at line 47 of file SurfaceFilmModel.C.

◆ SurfaceFilmModel() [3/3]

SurfaceFilmModel ( const SurfaceFilmModel< CloudType > & sfm )

Construct copy.

Definition at line 69 of file SurfaceFilmModel.C.

◆ ~SurfaceFilmModel()

~SurfaceFilmModel

virtual

Destructor.

Definition at line 88 of file SurfaceFilmModel.C.

Member Function Documentation

◆ filmPatches()

virtual const labelList& filmPatches ( ) const

protectedpure virtual

Return list of film patches.

Implemented in NoSurfaceFilm< CloudType >, and CloudFilmTransfer< CloudType >.

◆ cacheFilmFields()

virtual void cacheFilmFields ( const label filmi )

protectedpure virtual

Cache the film fields in preparation for injection.

Implemented in NoSurfaceFilm< CloudType >, and CloudFilmTransfer< CloudType >.

◆ setParcelProperties()

virtual void setParcelProperties	(	parcelType &	p,
		const label	filmFacei
	)		const

protectedpure virtual

Set the individual parcel properties.

Implemented in NoSurfaceFilm< CloudType >, and CloudFilmTransfer< CloudType >.

◆ TypeName()

TypeName ( "surfaceFilm" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

Declare runtime constructor selection table.

◆ clone()

virtual autoPtr<SurfaceFilmModel<CloudType> > clone ( ) const

pure virtual

Construct and return a clone.

Implemented in NoSurfaceFilm< CloudType >, and CloudFilmTransfer< CloudType >.

◆ New()

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

static

Selector.

Definition at line 32 of file SurfaceFilmModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, and Foam::nl.

Here is the call graph for this function:

◆ g()

const Foam::dimensionedVector & g

inline

Return gravitational acceleration constant.

Definition at line 31 of file SurfaceFilmModelI.H.

◆ nParcelsTransferred() [1/2]

Foam::label nParcelsTransferred

inline

Return const access to the number of parcels transferred to the.

film model

Definition at line 45 of file SurfaceFilmModelI.H.

◆ nParcelsTransferred() [2/2]

Foam::label & nParcelsTransferred

inline

Return non-const access to the number of parcels transferred to.

the film model

Definition at line 38 of file SurfaceFilmModelI.H.

◆ nParcelsInjected() [1/2]

Foam::label nParcelsInjected

inline

Return const access to the number of parcels injected from the.

film model

Definition at line 59 of file SurfaceFilmModelI.H.

◆ nParcelsInjected() [2/2]

Foam::label & nParcelsInjected

inline

Return non-const access to the number of parcels injected from.

the film model

Definition at line 52 of file SurfaceFilmModelI.H.

◆ transferParcel()

virtual bool transferParcel	(	parcelType &	p,
		const polyPatch &	pp,
		bool &	keepParticle
	)

pure virtual

Transfer parcel from cloud to surface film.

Returns true if parcel is to be transferred

Implemented in NoSurfaceFilm< CloudType >, and CloudFilmTransfer< CloudType >.

◆ inject()

void inject ( TrackCloudType & cloud )

Inject parcels into the cloud.

Definition at line 96 of file SurfaceFilmModel.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), polyMesh::boundaryMesh(), fvMesh::C(), forAll, fvMesh::magSf(), Foam::max(), Foam::offset(), Foam::pos(), and fvMesh::Sf().

Here is the call graph for this function:

◆ info()

void info ( Ostream & os )

virtual

Write surface film info to stream.

Reimplemented in NoSurfaceFilm< CloudType >, and CloudFilmTransfer< CloudType >.

Definition at line 164 of file SurfaceFilmModel.C.

References Foam::endl(), Foam::nl, and Foam::returnReduce().

Referenced by CloudFilmTransfer< CloudType >::info().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ g_

const dimensionedVector& g_

protected

Gravitational acceleration constant.

Definition at line 65 of file SurfaceFilmModel.H.

◆ ejectedParcelType_

label ejectedParcelType_

protected

Ejected parcel type label - id assigned to identify parcel for.

post-processing. If not specified, defaults to originating cloud type

Definition at line 70 of file SurfaceFilmModel.H.

◆ massParcelPatch_

scalarField massParcelPatch_

protected

Parcel mass / patch face.

Definition at line 76 of file SurfaceFilmModel.H.

◆ diameterParcelPatch_

scalarField diameterParcelPatch_

protected

Parcel diameter / patch face.

Definition at line 79 of file SurfaceFilmModel.H.

◆ deltaFilmPatch_

scalarField deltaFilmPatch_

protected

Film height of all film patches / patch face.

Definition at line 82 of file SurfaceFilmModel.H.

◆ nParcelsTransferred_

label nParcelsTransferred_

protected

Number of parcels transferred to the film model.

Definition at line 88 of file SurfaceFilmModel.H.

◆ nParcelsInjected_

label nParcelsInjected_

protected

Number of parcels injected from the film model.

Definition at line 91 of file SurfaceFilmModel.H.

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

src/lagrangian/parcel/clouds/Templates/MomentumCloud/MomentumCloud.H
src/lagrangian/parcel/submodels/Momentum/SurfaceFilmModel/SurfaceFilmModel/SurfaceFilmModel.H
src/lagrangian/parcel/submodels/Momentum/SurfaceFilmModel/SurfaceFilmModel/SurfaceFilmModel.C
src/lagrangian/parcel/submodels/Momentum/SurfaceFilmModel/SurfaceFilmModel/SurfaceFilmModelI.H
src/lagrangian/parcel/submodels/Momentum/SurfaceFilmModel/SurfaceFilmModel/SurfaceFilmModelNew.C

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::SurfaceFilmModel< CloudType >

Member Typedef Documentation

◆ parcelType

Constructor & Destructor Documentation

◆ SurfaceFilmModel() [1/3]

◆ SurfaceFilmModel() [2/3]

◆ SurfaceFilmModel() [3/3]

◆ ~SurfaceFilmModel()

Member Function Documentation

◆ filmPatches()

◆ cacheFilmFields()

◆ setParcelProperties()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ g()

◆ nParcelsTransferred() [1/2]

◆ nParcelsTransferred() [2/2]

◆ nParcelsInjected() [1/2]

◆ nParcelsInjected() [2/2]

◆ transferParcel()

◆ inject()

◆ info()

Member Data Documentation

◆ g_

◆ ejectedParcelType_

◆ massParcelPatch_

◆ diameterParcelPatch_

◆ deltaFilmPatch_

◆ nParcelsTransferred_

◆ nParcelsInjected_

template<class CloudType>
class Foam::SurfaceFilmModel< CloudType >