Templated wall surface film model class. More...

Inheritance diagram for SurfaceFilmModel< CloudType >:

Collaboration diagram for SurfaceFilmModel< CloudType >:

Public Member Functions
	TypeName ("surfaceFilmModel")
	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...

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 void	cacheFilmFields (const label filmPatchi, const label primaryPatchi, const regionModels::surfaceFilmModels::surfaceFilmRegionModel &)
	Cache the film fields in preparation for injection. More...

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

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

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

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

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

List< vector >	UFilmPatch_
	Film velocity / patch face. More...

scalarList	rhoFilmPatch_
	Film density / patch face. More...

scalarListList	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...

Detailed Description

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

Templated wall surface film model class.

Source files

Definition at line 92 of file KinematicCloud.H.

Member Typedef Documentation

◆ parcelType

typedef CloudType::parcelType parcelType

protected

Convenience typedef to the cloud's parcel type.

Definition at line 76 of file SurfaceFilmModel.H.

Constructor & Destructor Documentation

◆ SurfaceFilmModel() [1/3]

SurfaceFilmModel ( CloudType & owner )

Construct null from owner.

Definition at line 38 of file SurfaceFilmModel.C.

◆ SurfaceFilmModel() [2/3]

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

Construct from components.

Definition at line 55 of file SurfaceFilmModel.C.

◆ SurfaceFilmModel() [3/3]

SurfaceFilmModel ( const SurfaceFilmModel< CloudType > & sfm )

Construct copy.

Definition at line 79 of file SurfaceFilmModel.C.

◆ ~SurfaceFilmModel()

~SurfaceFilmModel ( )

virtual

Destructor.

Definition at line 99 of file SurfaceFilmModel.C.

Member Function Documentation

◆ cacheFilmFields()

void cacheFilmFields	(	const label	filmPatchi,
		const label	primaryPatchi,
		const regionModels::surfaceFilmModels::surfaceFilmRegionModel &	filmModel
	)

protectedvirtual

Cache the film fields in preparation for injection.

Reimplemented in ThermoSurfaceFilm< CloudType >.

Definition at line 193 of file SurfaceFilmModel.C.

Referenced by ThermoSurfaceFilm< CloudType >::cacheFilmFields().

Here is the caller graph for this function:

◆ setParcelProperties()

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

protectedvirtual

Set the individual parcel properties.

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

Definition at line 220 of file SurfaceFilmModel.C.

Referenced by ThermoSurfaceFilm< CloudType >::setParcelProperties().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "surfaceFilmModel" )

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 ThermoSurfaceFilm< CloudType >, and NoSurfaceFilm< CloudType >.

◆ New()

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

static

Selector.

Definition at line 36 of file SurfaceFilmModelNew.C.

◆ g()

const Foam::dimensionedVector & g ( ) const

inline

Return gravitational acceleration constant.

Definition at line 33 of file SurfaceFilmModelI.H.

◆ nParcelsTransferred() [1/2]

Foam::label nParcelsTransferred ( ) const

inline

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

film model

Definition at line 47 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 40 of file SurfaceFilmModelI.H.

◆ nParcelsInjected() [1/2]

Foam::label nParcelsInjected ( ) const

inline

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

film model

Definition at line 61 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 54 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 ThermoSurfaceFilm< CloudType >, and NoSurfaceFilm< CloudType >.

◆ inject()

void inject ( TrackCloudType & cloud )

Inject parcels into the cloud.

Definition at line 107 of file SurfaceFilmModel.C.

◆ info()

void info ( Ostream & os )

virtual

Write surface film info to stream.

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

Definition at line 241 of file SurfaceFilmModel.C.

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

Here is the caller graph for this function:

Member Data Documentation

◆ g_

const dimensionedVector& g_

protected

Gravitational acceleration constant.

Definition at line 79 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 84 of file SurfaceFilmModel.H.

◆ massParcelPatch_

scalarList massParcelPatch_

protected

Parcel mass / patch face.

Definition at line 90 of file SurfaceFilmModel.H.

◆ diameterParcelPatch_

scalarList diameterParcelPatch_

protected

Parcel diameter / patch face.

Definition at line 93 of file SurfaceFilmModel.H.

◆ UFilmPatch_

List<vector> UFilmPatch_

protected

Film velocity / patch face.

Definition at line 96 of file SurfaceFilmModel.H.

◆ rhoFilmPatch_

scalarList rhoFilmPatch_

protected

Film density / patch face.

Definition at line 99 of file SurfaceFilmModel.H.

◆ deltaFilmPatch_

scalarListList deltaFilmPatch_

protected

Film height of all film patches / patch face.

Definition at line 102 of file SurfaceFilmModel.H.

◆ nParcelsTransferred_

label nParcelsTransferred_

protected

Number of parcels transferred to the film model.

Definition at line 108 of file SurfaceFilmModel.H.

◆ nParcelsInjected_

label nParcelsInjected_

protected

Number of parcels injected from the film model.

Definition at line 111 of file SurfaceFilmModel.H.

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

src/lagrangian/intermediate/clouds/Templates/KinematicCloud/KinematicCloud.H
src/lagrangian/intermediate/submodels/Kinematic/SurfaceFilmModel/SurfaceFilmModel/SurfaceFilmModel.H
src/lagrangian/intermediate/submodels/Kinematic/SurfaceFilmModel/SurfaceFilmModel/SurfaceFilmModel.C
src/lagrangian/intermediate/submodels/Kinematic/SurfaceFilmModel/SurfaceFilmModel/SurfaceFilmModelI.H
src/lagrangian/intermediate/submodels/Kinematic/SurfaceFilmModel/SurfaceFilmModel/SurfaceFilmModelNew.C

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

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

◆ 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_

◆ UFilmPatch_

◆ rhoFilmPatch_

◆ deltaFilmPatch_

◆ nParcelsTransferred_

◆ nParcelsInjected_

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