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

scalar &	totalMassTransferred ()
	Return non-const total mass transferred. More...

scalar	totalMassTransferred () const
	Return consr access to mass transferred. 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...

template<class CloudTrackType >
void	injectParticles (const label primaryPatchi, const labelList &injectorCellsPatch, CloudTrackType &cloud)

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

typedef regionModels::areaSurfaceFilmModels::liquidFilmBase	areaFilm

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	cacheFilmFields (const label primaryPatchi, const areaFilm &)
	Cache the finite area film fields in preparation for injection. More...

template<class TrackCloudType >
void	injectParticles (const label primaryPatchi, const labelList &injectorCellsPatch, TrackCloudType &cloud)
	Inject particles in cloud. 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...

scalar	injectionOffset_
	Injection offset position. More...

scalar	minDiameter_
	Minimum diameter particle injection. More...

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

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

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

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

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

scalar	totalMassTransferred_
	Total mass transferred to the film. 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 87 of file SurfaceFilmModel.H.

◆ areaFilm

typedef regionModels::areaSurfaceFilmModels::liquidFilmBase areaFilm

protected

Definition at line 90 of file SurfaceFilmModel.H.

Constructor & Destructor Documentation

◆ SurfaceFilmModel() [1/3]

SurfaceFilmModel ( CloudType & owner )

Construct null from owner.

Definition at line 39 of file SurfaceFilmModel.C.

◆ SurfaceFilmModel() [2/3]

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

Construct from components.

Definition at line 59 of file SurfaceFilmModel.C.

◆ SurfaceFilmModel() [3/3]

SurfaceFilmModel ( const SurfaceFilmModel< CloudType > & sfm )

Construct copy.

Definition at line 92 of file SurfaceFilmModel.C.

◆ ~SurfaceFilmModel()

~SurfaceFilmModel ( )

virtual

Destructor.

Definition at line 115 of file SurfaceFilmModel.C.

Member Function Documentation

◆ cacheFilmFields() [1/2]

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

protectedvirtual

Cache the film fields in preparation for injection.

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

Definition at line 267 of file SurfaceFilmModel.C.

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

Here is the caller graph for this function:

◆ cacheFilmFields() [2/2]

void cacheFilmFields	(	const label	primaryPatchi,
		const areaFilm &	filmModel
	)

protectedvirtual

Cache the finite area film fields in preparation for injection.

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

Definition at line 294 of file SurfaceFilmModel.C.

◆ injectParticles() [1/2]

void injectParticles	(	const label	primaryPatchi,
		const labelList &	injectorCellsPatch,
		TrackCloudType &	cloud
	)

protected

Inject particles in cloud.

◆ setParcelProperties()

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

protectedvirtual

Set the individual parcel properties.

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

Definition at line 327 of file SurfaceFilmModel.C.

Referenced by KinematicSurfaceFilm< 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 KinematicSurfaceFilm< CloudType >, 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.

◆ totalMassTransferred() [1/2]

Foam::scalar & totalMassTransferred ( )

inline

Return non-const total mass transferred.

Definition at line 67 of file SurfaceFilmModelI.H.

◆ totalMassTransferred() [2/2]

Foam::scalar totalMassTransferred ( ) const

inline

Return consr access to mass transferred.

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

◆ inject()

void inject ( TrackCloudType & cloud )

Inject parcels into the cloud.

Definition at line 180 of file SurfaceFilmModel.C.

◆ info()

void info ( Ostream & os )

virtual

Write surface film info to stream.

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

Definition at line 356 of file SurfaceFilmModel.C.

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

Here is the caller graph for this function:

◆ injectParticles() [2/2]

void injectParticles	(	const label	primaryPatchi,
		const labelList &	injectorCellsPatch,
		CloudTrackType &	cloud
	)

Definition at line 124 of file SurfaceFilmModel.C.

Member Data Documentation

◆ g_

const dimensionedVector& g_

protected

Gravitational acceleration constant.

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

◆ injectionOffset_

scalar injectionOffset_

protected

Injection offset position.

Definition at line 101 of file SurfaceFilmModel.H.

◆ minDiameter_

scalar minDiameter_

protected

Minimum diameter particle injection.

Definition at line 104 of file SurfaceFilmModel.H.

◆ massParcelPatch_

scalarField massParcelPatch_

protected

Parcel mass / patch face.

Definition at line 110 of file SurfaceFilmModel.H.

◆ diameterParcelPatch_

scalarField diameterParcelPatch_

protected

Parcel diameter / patch face.

Definition at line 113 of file SurfaceFilmModel.H.

◆ UFilmPatch_

Field<vector> UFilmPatch_

protected

Film velocity / patch face.

Definition at line 116 of file SurfaceFilmModel.H.

◆ rhoFilmPatch_

scalarField rhoFilmPatch_

protected

Film density / patch face.

Definition at line 119 of file SurfaceFilmModel.H.

◆ deltaFilmPatch_

Field<scalarField> deltaFilmPatch_

protected

Film height of all film patches / patch face.

Definition at line 122 of file SurfaceFilmModel.H.

◆ nParcelsTransferred_

label nParcelsTransferred_

protected

Number of parcels transferred to the film model.

Definition at line 128 of file SurfaceFilmModel.H.

◆ nParcelsInjected_

label nParcelsInjected_

protected

Number of parcels injected from the film model.

Definition at line 131 of file SurfaceFilmModel.H.

◆ totalMassTransferred_

scalar totalMassTransferred_

protected

Total mass transferred to the film.

Definition at line 137 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

◆ areaFilm

Constructor & Destructor Documentation

◆ SurfaceFilmModel() [1/3]

◆ SurfaceFilmModel() [2/3]

◆ SurfaceFilmModel() [3/3]

◆ ~SurfaceFilmModel()

Member Function Documentation

◆ cacheFilmFields() [1/2]

◆ cacheFilmFields() [2/2]

◆ injectParticles() [1/2]

◆ setParcelProperties()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ g()

◆ nParcelsTransferred() [1/2]

◆ nParcelsTransferred() [2/2]

◆ nParcelsInjected() [1/2]

◆ nParcelsInjected() [2/2]

◆ totalMassTransferred() [1/2]

◆ totalMassTransferred() [2/2]

◆ transferParcel()

◆ inject()

◆ info()

◆ injectParticles() [2/2]

Member Data Documentation

◆ g_

◆ ejectedParcelType_

◆ injectionOffset_

◆ minDiameter_

◆ massParcelPatch_

◆ diameterParcelPatch_

◆ UFilmPatch_

◆ rhoFilmPatch_

◆ deltaFilmPatch_

◆ nParcelsTransferred_

◆ nParcelsInjected_

◆ totalMassTransferred_

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