Place holder for 'none' option. More...

#include <NoSurfaceFilm.H>

Inheritance diagram for NoSurfaceFilm< CloudType >:

Collaboration diagram for NoSurfaceFilm< CloudType >:

Public Member Functions
	TypeName ("none")
	Runtime type information.
	NoSurfaceFilm (const dictionary &, CloudType &)
	Construct from dictionary.
	NoSurfaceFilm (const NoSurfaceFilm< CloudType > &dm)
	Construct copy.
virtual autoPtr< SurfaceFilmModel< CloudType > >	clone () const
	Construct and return a clone.
virtual	~NoSurfaceFilm ()
	Destructor.
virtual bool	active () const
	Flag to indicate whether model activates the surface film model.
virtual bool	transferParcel (parcelType &p, const polyPatch &pp, bool &keepParticle)
	Transfer parcel from cloud to surface film.
virtual void	setParcelProperties (parcelType &p, const label filmCelli) const
	Set parcel properties.
Public Member Functions inherited from SurfaceFilmModel< CloudType >
	TypeName ("surfaceFilmModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, SurfaceFilmModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
	Declare runtime constructor selection table.
	SurfaceFilmModel (CloudType &owner)
	Construct null from owner.
	SurfaceFilmModel (const dictionary &dict, CloudType &owner, const word &type)
	Construct from components.
	SurfaceFilmModel (const SurfaceFilmModel< CloudType > &sfm)
	Construct copy.
virtual	~SurfaceFilmModel ()=default
	Destructor.
const dimensionedVector &	g () const noexcept
	Return gravitational acceleration constant.
label	nParcelsTransferred () const noexcept
	The number of parcels transferred to the film model.
label &	nParcelsTransferred () noexcept
	Non-const access to number of parcels transferred to the film model.
label	nParcelsInjected () const noexcept
	The number of parcels injected from the film model.
label &	nParcelsInjected () noexcept
	Non-const access to number of parcels injected from the film model.
scalar	totalMassTransferred () const noexcept
	The total mass transferred.
scalar &	totalMassTransferred () noexcept
	Non-const access to the total mass transferred.
template<class TrackCloudType>
void	inject (TrackCloudType &cloud)
	Inject parcels into the cloud.
virtual void	info ()
	Write surface film info.
template<class CloudTrackType>
void	injectParticles (const label primaryPatchi, const labelUList &injectorCells, CloudTrackType &cloud)
template<class CloudTrackType>
void	injectParticles (const UList< labelPair > &patchFaces, CloudTrackType &cloud)
Public Member Functions inherited from CloudSubModelBase< CloudType >
	CloudSubModelBase (CloudType &owner)
	Construct null from owner cloud.
	CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from owner cloud without name.
	CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from owner cloud with name.
	CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
	Construct as copy.
virtual	~CloudSubModelBase ()=default
	Destructor.
const CloudType &	owner () const
	Return const access to the owner cloud.
virtual bool	writeTime () const
	Flag to indicate when to write a property.
virtual fileName	localPath () const
	Output directory.
CloudType &	owner ()
	Return non-const access to the owner cloud for manipulation.
virtual void	write (Ostream &os) const
	Write to os.
Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	Construct null.
	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from components without name.
	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from components with name.
	subModelBase (const subModelBase &smb)
	Construct as copy.
virtual	~subModelBase ()=default
	Destructor.
const word &	modelName () const
	Return const access to the name of the sub-model.
const dictionary &	dict () const
	Return const access to the cloud dictionary.
const word &	baseName () const
	Return const access to the base name of the sub-model.
const word &	modelType () const
	Return const access to the sub-model type.
const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary.
const dictionary &	properties () const
	Return const access to the properties dictionary.
virtual bool	defaultCoeffs (const bool printMsg) const
	Returns true if defaultCoeffs is true and outputs on printMsg.
virtual void	cacheFields (const bool store)
	Cache dependent sub-model fields.
template<class Type>
Type	getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the base model.
template<class Type>
void	getBaseProperty (const word &entryName, Type &value) const
	Retrieve generic property from the base model.
template<class Type>
void	setBaseProperty (const word &entryName, const Type &value)
	Add generic property to the base model.
bool	getModelDict (const word &entryName, dictionary &dict) const
	Retrieve dictionary, return true if set.
template<class Type>
bool	getModelProperty (const word &entryName, Type &value) const
	Retrieve generic property from the sub-model.
template<class Type>
Type	getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the sub-model.
template<class Type>
void	setModelProperty (const word &entryName, const Type &value)
	Add generic property to the sub-model.

Protected Types
typedef CloudType::parcelType	parcelType
	Convenience typedef for parcel type.
Protected Types inherited from SurfaceFilmModel< CloudType >
typedef CloudType::parcelType	parcelType
	Convenience typedef to the cloud's parcel type.
typedef regionModels::areaSurfaceFilmModels::liquidFilmBase	areaFilm
typedef regionModels::surfaceFilmModels::surfaceFilmRegionModel	regionFilm

Additional Inherited Members
Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType
	Type of cloud this model was instantiated for.
Static Public Member Functions inherited from SurfaceFilmModel< CloudType >
static autoPtr< SurfaceFilmModel< CloudType > >	New (const dictionary &dict, CloudType &owner)
	Selector.
static UPtrList< const areaFilm >	csorted_areaFilms (const polyMesh &)
	Registry.
static UPtrList< areaFilm >	sorted_areaFilms (const polyMesh &)
	Return a sorted list of area-film objects that are registered on the faMeshesRegistry.
Public Attributes inherited from subModelBase
bool	log
	Flag to write log into Info.
Protected Member Functions inherited from SurfaceFilmModel< CloudType >
virtual void	cacheFilmFields (const label filmPatchi, const label primaryPatchi, const regionFilm &)
	Cache the film fields in preparation for injection.
virtual void	cacheFilmFields (const areaFilm &film)
	Cache the finite area film fields in preparation for injection.
template<class TrackCloudType>
void	injectParticles (const label primaryPatchi, const labelUList &injectorCells, TrackCloudType &cloud)
	Inject particles in cloud.
template<class TrackCloudType>
void	injectParticles (const UList< labelPair > &patchFaces, TrackCloudType &cloud)
	Inject particles in cloud.
Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line.
Protected Attributes inherited from SurfaceFilmModel< CloudType >
const dimensionedVector &	g_
	Gravitational acceleration constant.
label	ejectedParcelType_
	Ejected parcel type label - id assigned to identify parcel for post-processing. If not specified, defaults to originating cloud type.
scalar	injectionOffset_
	Injection offset position.
scalar	minDiameter_
	Minimum diameter particle injection.
scalarField	massParcelPatch_
	Parcel mass / patch face.
scalarField	diameterParcelPatch_
	Parcel diameter / patch face.
Field< vector >	UFilmPatch_
	Film velocity / patch face.
scalarField	rhoFilmPatch_
	Film density / patch face.
Field< scalarField >	deltaFilmPatch_
	Film height of all film patches / patch face.
label	nParcelsTransferred_
	Number of parcels transferred to the film model.
label	nParcelsInjected_
	Number of parcels injected from the film model.
scalar	totalMassTransferred_
	Total mass transferred to the film.
Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_
	Reference to the cloud.
Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model.
dictionary &	properties_
	Reference to properties dictionary e.g. for restart.
const dictionary	dict_
	Copy of dictionary used during construction.
const word	baseName_
	Name of the sub-model base class.
const word	modelType_
	Type of the sub-model.
const dictionary	coeffDict_
	Coefficients dictionary.

Detailed Description

template<class CloudType>
class Foam::NoSurfaceFilm< CloudType >

Place holder for 'none' option.

Source files

Definition at line 50 of file NoSurfaceFilm.H.

Member Typedef Documentation

◆ parcelType

template<class CloudType>

typedef CloudType::parcelType parcelType

protected

Convenience typedef for parcel type.

Definition at line 61 of file NoSurfaceFilm.H.

Constructor & Destructor Documentation

◆ NoSurfaceFilm() [1/2]

template<class CloudType>

NoSurfaceFilm	(	const dictionary &	,
		CloudType &	owner )

Construct from dictionary.

Definition at line 27 of file NoSurfaceFilm.C.

References CloudSubModelBase< CloudType >::owner(), and SurfaceFilmModel< CloudType >::SurfaceFilmModel().

Referenced by clone(), NoSurfaceFilm(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NoSurfaceFilm() [2/2]

template<class CloudType>

NoSurfaceFilm ( const NoSurfaceFilm< CloudType > & dm )

Construct copy.

Definition at line 38 of file NoSurfaceFilm.C.

References NoSurfaceFilm(), CloudSubModelBase< CloudType >::owner_, and SurfaceFilmModel< CloudType >::SurfaceFilmModel().

Here is the call graph for this function:

◆ ~NoSurfaceFilm()

template<class CloudType>

~NoSurfaceFilm ( )

virtual

Destructor.

Definition at line 50 of file NoSurfaceFilm.C.

Member Function Documentation

◆ TypeName()

template<class CloudType>

TypeName ( "none" )

Runtime type information.

References NoSurfaceFilm().

Here is the call graph for this function:

◆ clone()

template<class CloudType>

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

inlinevirtual

Construct and return a clone.

Implements SurfaceFilmModel< CloudType >.

Definition at line 87 of file NoSurfaceFilm.H.

References NoSurfaceFilm().

Here is the call graph for this function:

◆ active()

template<class CloudType>

bool active ( ) const

virtual

Flag to indicate whether model activates the surface film model.

Reimplemented from subModelBase.

Definition at line 57 of file NoSurfaceFilm.C.

◆ transferParcel()

template<class CloudType>

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

virtual

Transfer parcel from cloud to surface film.

Returns true if parcel is to be transferred

Implements SurfaceFilmModel< CloudType >.

Definition at line 64 of file NoSurfaceFilm.C.

◆ setParcelProperties()

template<class CloudType>

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

virtual

Set parcel properties.

Reimplemented from SurfaceFilmModel< CloudType >.

Definition at line 76 of file NoSurfaceFilm.C.

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

src/lagrangian/intermediate/submodels/Kinematic/SurfaceFilmModel/NoSurfaceFilm/NoSurfaceFilm.H
src/lagrangian/intermediate/submodels/Kinematic/SurfaceFilmModel/NoSurfaceFilm/NoSurfaceFilm.C

Public Member Functions

Protected Types

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ parcelType

Constructor & Destructor Documentation

◆ NoSurfaceFilm() [1/2]

◆ NoSurfaceFilm() [2/2]

◆ ~NoSurfaceFilm()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ active()

◆ transferParcel()

◆ setParcelProperties()