Templated wall surface film model class. More...

Inheritance diagram for SurfaceFilmModel:

Collaboration diagram for SurfaceFilmModel:

[legend]

Public Member Functions
	TypeName ("surfaceFilmModel")

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

	SurfaceFilmModel (CloudType &owner)

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

	SurfaceFilmModel (const SurfaceFilmModel< CloudType > &sfm)

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

virtual	~SurfaceFilmModel ()

const dimensionedVector &	g () const

label	nParcelsTransferred () const

label &	nParcelsTransferred ()

label	nParcelsInjected () const

label &	nParcelsInjected ()

scalar &	totalMassTransferred ()

scalar	totalMassTransferred () const

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

template<class TrackCloudType >
void	inject (TrackCloudType &cloud)

virtual void	info (Ostream &os)

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)

Protected Types
typedef CloudType::parcelType	parcelType

typedef regionModels::areaSurfaceFilmModels::liquidFilmBase	areaFilm

Protected Member Functions
virtual void	cacheFilmFields (const label filmPatchi, const label primaryPatchi, const regionModels::surfaceFilmModels::surfaceFilmRegionModel &)

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

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

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

Protected Attributes
const dimensionedVector &	g_

label	ejectedParcelType_

scalar	injectionOffset_

scalar	minDiameter_

scalarField	massParcelPatch_

scalarField	diameterParcelPatch_

Field< vector >	UFilmPatch_

scalarField	rhoFilmPatch_

Field< scalarField >	deltaFilmPatch_

label	nParcelsTransferred_

label	nParcelsInjected_

scalar	totalMassTransferred_

Detailed Description

Templated wall surface film model class.

Source files

Definition at line 88 of file KinematicCloud.H.

Member Typedef Documentation

◆ parcelType

typedef CloudType::parcelType parcelType

protected

Definition at line 83 of file SurfaceFilmModel.H.

◆ areaFilm

typedef regionModels::areaSurfaceFilmModels::liquidFilmBase areaFilm

protected

Definition at line 86 of file SurfaceFilmModel.H.

Constructor & Destructor Documentation

◆ SurfaceFilmModel() [1/3]

SurfaceFilmModel ( CloudType & owner )

Definition at line 32 of file SurfaceFilmModel.C.

◆ SurfaceFilmModel() [2/3]

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

Definition at line 52 of file SurfaceFilmModel.C.

◆ SurfaceFilmModel() [3/3]

SurfaceFilmModel ( const SurfaceFilmModel< CloudType > & sfm )

Definition at line 85 of file SurfaceFilmModel.C.

◆ ~SurfaceFilmModel()

~SurfaceFilmModel ( )

virtual

Definition at line 108 of file SurfaceFilmModel.C.

Member Function Documentation

◆ cacheFilmFields() [1/2]

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

protectedvirtual

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

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

Here is the caller graph for this function:

◆ cacheFilmFields() [2/2]

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

protectedvirtual

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

◆ injectParticles() [1/2]

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

protected

◆ setParcelProperties()

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

protectedvirtual

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

Definition at line 320 of file SurfaceFilmModel.C.

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

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "surfaceFilmModel" )

◆ declareRunTimeSelectionTable()

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

◆ clone()

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

pure virtual

◆ New()

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

static

Definition at line 29 of file SurfaceFilmModelNew.C.

◆ g()

const Foam::dimensionedVector & g ( ) const

inline

Definition at line 26 of file SurfaceFilmModelI.H.

◆ nParcelsTransferred() [1/2]

Foam::label nParcelsTransferred ( ) const

inline

Definition at line 40 of file SurfaceFilmModelI.H.

◆ nParcelsTransferred() [2/2]

Foam::label & nParcelsTransferred ( )

inline

Definition at line 33 of file SurfaceFilmModelI.H.

◆ nParcelsInjected() [1/2]

Foam::label nParcelsInjected ( ) const

inline

Definition at line 54 of file SurfaceFilmModelI.H.

◆ nParcelsInjected() [2/2]

Foam::label & nParcelsInjected ( )

inline

Definition at line 47 of file SurfaceFilmModelI.H.

◆ totalMassTransferred() [1/2]

Foam::scalar & totalMassTransferred ( )

inline

Definition at line 60 of file SurfaceFilmModelI.H.

◆ totalMassTransferred() [2/2]

Foam::scalar totalMassTransferred ( ) const

inline

Definition at line 67 of file SurfaceFilmModelI.H.

◆ transferParcel()

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

pure virtual

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

◆ inject()

void inject ( TrackCloudType & cloud )

Definition at line 173 of file SurfaceFilmModel.C.

◆ info()

void info ( Ostream & os )

virtual

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

Definition at line 349 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 117 of file SurfaceFilmModel.C.

Member Data Documentation

◆ g_

const dimensionedVector& g_

protected

Definition at line 89 of file SurfaceFilmModel.H.

◆ ejectedParcelType_

label ejectedParcelType_

protected

Definition at line 94 of file SurfaceFilmModel.H.

◆ injectionOffset_

scalar injectionOffset_

protected

Definition at line 97 of file SurfaceFilmModel.H.

◆ minDiameter_

scalar minDiameter_

protected

Definition at line 100 of file SurfaceFilmModel.H.

◆ massParcelPatch_

scalarField massParcelPatch_

protected

Definition at line 106 of file SurfaceFilmModel.H.

◆ diameterParcelPatch_

scalarField diameterParcelPatch_

protected

Definition at line 109 of file SurfaceFilmModel.H.

◆ UFilmPatch_

Field<vector> UFilmPatch_

protected

Definition at line 112 of file SurfaceFilmModel.H.

◆ rhoFilmPatch_

scalarField rhoFilmPatch_

protected

Definition at line 115 of file SurfaceFilmModel.H.

◆ deltaFilmPatch_

Field<scalarField> deltaFilmPatch_

protected

Definition at line 118 of file SurfaceFilmModel.H.

◆ nParcelsTransferred_

label nParcelsTransferred_

protected

Definition at line 124 of file SurfaceFilmModel.H.

◆ nParcelsInjected_

label nParcelsInjected_

protected

Definition at line 127 of file SurfaceFilmModel.H.

◆ totalMassTransferred_

scalar totalMassTransferred_

protected

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

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_