Thermo parcel surface film model. More...

#include <ThermoSurfaceFilm.H>

Inheritance diagram for ThermoSurfaceFilm< CloudType >:

Collaboration diagram for ThermoSurfaceFilm< CloudType >:

[legend]

Public Member Functions
	TypeName ("thermoSurfaceFilm")
	Runtime type information.
	ThermoSurfaceFilm (const dictionary &dict, CloudType &owner)
	Construct from components.
	ThermoSurfaceFilm (const ThermoSurfaceFilm< CloudType > &sfm)
	Construct copy.
virtual autoPtr< SurfaceFilmModel< CloudType > >	clone () const
	Construct and return a clone using supplied owner cloud.
virtual	~ThermoSurfaceFilm ()=default
	Destructor.
template<class filmType>
void	absorbInteraction (filmType &, const parcelType &p, const polyPatch &pp, const label facei, const scalar mass, bool &keepParticle)
	Absorb parcel into film.
virtual bool	transferParcel (parcelType &p, const polyPatch &pp, bool &keepParticle)
	Transfer parcel from cloud to surface film.
virtual void	info ()
	Write surface film info.
Public Member Functions inherited from KinematicSurfaceFilm< CloudType >
	TypeName ("kinematicSurfaceFilm")
	Runtime type information.
	KinematicSurfaceFilm (const dictionary &dict, CloudType &owner, const word &type=typeName, bool initThermo=true)
	Construct from components.
	KinematicSurfaceFilm (const KinematicSurfaceFilm< CloudType > &sfm, bool initThermo=true)
	Construct copy.
virtual	~KinematicSurfaceFilm ()=default
	Destructor.
template<class filmType>
void	absorbInteraction (filmType &, const parcelType &p, const polyPatch &pp, const label facei, const scalar mass, bool &keepParticle)
	Absorb parcel into film.
void	bounceInteraction (parcelType &p, const polyPatch &pp, const label facei, bool &keepParticle) const
	Bounce parcel (flip parcel normal velocity).
template<class filmType>
void	drySplashInteraction (filmType &, const scalar sigma, const scalar mu, const parcelType &p, const polyPatch &pp, const label facei, bool &keepParticle)
	Parcel interaction with dry surface.
template<class filmType>
void	wetSplashInteraction (filmType &, const scalar sigma, const scalar mu, parcelType &p, const polyPatch &pp, const label facei, bool &keepParticle)
	Parcel interaction with wetted surface.
template<class filmType>
void	splashInteraction (filmType &, const parcelType &p, const polyPatch &pp, const label facei, const scalar mRatio, const scalar We, const scalar Wec, const scalar sigma, bool &keepParticle)
	Bai parcel splash interaction model.
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.
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 bool	active () const
	Return the model 'active' status - default active = true.
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 to the cloud's parcel type.
typedef regionModels::areaSurfaceFilmModels::liquidFilmBase	areaFilm
typedef regionModels::surfaceFilmModels::surfaceFilmRegionModel	regionFilm
Protected Types inherited from KinematicSurfaceFilm< CloudType >
typedef CloudType::parcelType	parcelType
	Convenience typedef to the cloud's parcel type.
typedef regionModels::areaSurfaceFilmModels::liquidFilmBase	areaFilm
typedef regionModels::surfaceFilmModels::surfaceFilmRegionModel	regionFilm
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

Protected Member Functions
virtual void	cacheFilmFields (const label filmPatchi, const label primaryPatchi, const regionFilm &)
	Cache the film fields in preparation for injection.
virtual void	cacheFilmFields (const areaFilm &)
	Cache the finite area film fields in preparation for injection.
virtual void	setParcelProperties (parcelType &p, const label filmFacei) const
	Set the individual parcel properties.
Protected Member Functions inherited from KinematicSurfaceFilm< CloudType >
vector	tangentVector (const vector &v) const
	Return a vector tangential to input vector, v.
vector	splashDirection (const vector &tanVec1, const vector &tanVec2, const vector &nf) const
	Return splashed parcel direction.
void	init (bool binitThermo)
	Initialise thermo.
void	initFilmModels ()
	Initialise pointers of films.
Protected Member Functions inherited from SurfaceFilmModel< CloudType >
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
const SLGThermo &	thermo_
	Reference to the cloud thermo package.
scalarField	TFilmPatch_
	Film temperature / patch face.
scalarField	CpFilmPatch_
	Film specific heat capacity / patch face.
Protected Attributes inherited from KinematicSurfaceFilm< CloudType >
Random &	rndGen_
	Reference to the cloud random number generator.
liquidMixtureProperties *	thermo_
	Region Film liquid thermo.
scalar	pRef_
	Region Film reference pressure.
scalar	TRef_
	Region Film reference temperature.
regionFilm *	filmModel_
	Pointer to filmModel.
UPtrList< areaFilm >	areaFilms_
	UPointers to area films.
interactionType	interactionType_
	Interaction type enumeration.
labelList	parcelTypes_
	Particle type IDs that can interact with the film.
scalar	deltaWet_
	Film thickness beyond which patch is assumed to be wet.
label	splashParcelType_
	Splash parcel type label - id assigned to identify parcel for.
label	parcelsPerSplash_
	Number of new parcels resulting from splash event.
scalar	dMaxSplash_
	Maximum splash particle diameter for Chi-square distribution.
scalar	dMinSplash_
	Minimum splash particle diameter for Chi-square distribution.
scalar	Adry_
	Dry surface roughness coefficient.
scalar	Awet_
	Wet surface roughness coefficient.
scalar	Cf_
	Skin friction typically in the range 0.6 < Cf < 0.8.
label	nParcelsSplashed_
	Counter for number of new splash parcels.
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.

Additional Inherited Members
Public Types inherited from KinematicSurfaceFilm< CloudType >
enum class	interactionType { absorb , bounce , splashBai }
	Options for the interaction types. More...
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.
Static Public Attributes inherited from KinematicSurfaceFilm< CloudType >
static const Enum< interactionType >	interactionTypeNames
	Names for interactionType.

Detailed Description

template<class CloudType>
class Foam::ThermoSurfaceFilm< CloudType >

Thermo parcel surface film model.

Source files

Definition at line 53 of file ThermoSurfaceFilm.H.

Member Typedef Documentation

◆ parcelType

template<class CloudType>

typedef CloudType::parcelType parcelType

protected

Convenience typedef to the cloud's parcel type.

Definition at line 64 of file ThermoSurfaceFilm.H.

◆ areaFilm

template<class CloudType>

typedef regionModels::areaSurfaceFilmModels::liquidFilmBase areaFilm

protected

Definition at line 68 of file ThermoSurfaceFilm.H.

◆ regionFilm

template<class CloudType>

typedef regionModels::surfaceFilmModels::surfaceFilmRegionModel regionFilm

protected

Definition at line 72 of file ThermoSurfaceFilm.H.

Constructor & Destructor Documentation

◆ ThermoSurfaceFilm() [1/2]

template<class CloudType>

ThermoSurfaceFilm	(	const dictionary &	dict,
		CloudType &	owner )

Construct from components.

Definition at line 27 of file ThermoSurfaceFilm.C.

References CpFilmPatch_, dict, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, KinematicSurfaceFilm< CloudType >::KinematicSurfaceFilm(), CloudSubModelBase< CloudType >::owner(), TFilmPatch_, and thermo_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ThermoSurfaceFilm() [2/2]

template<class CloudType>

ThermoSurfaceFilm ( const ThermoSurfaceFilm< CloudType > & sfm )

Construct copy.

Definition at line 44 of file ThermoSurfaceFilm.C.

References CpFilmPatch_, KinematicSurfaceFilm< CloudType >::KinematicSurfaceFilm(), TFilmPatch_, thermo_, and ThermoSurfaceFilm().

Here is the call graph for this function:

◆ ~ThermoSurfaceFilm()

template<class CloudType>

virtual ~ThermoSurfaceFilm ( )

virtualdefault

Destructor.

References p, and pp().

Here is the call graph for this function:

Member Function Documentation

◆ cacheFilmFields() [1/2]

template<class CloudType>

void cacheFilmFields	(	const label	filmPatchi,
		const label	primaryPatchi,
		const regionFilm &	filmModel )

protectedvirtual

Cache the film fields in preparation for injection.

Reimplemented from KinematicSurfaceFilm< CloudType >.

Definition at line 264 of file ThermoSurfaceFilm.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), KinematicSurfaceFilm< CloudType >::cacheFilmFields(), surfaceFilmRegionModel::Cp(), CpFilmPatch_, TFilmPatch_, regionModel::toPrimary(), and surfaceFilmRegionModel::Ts().

Here is the call graph for this function:

◆ cacheFilmFields() [2/2]

template<class CloudType>

void cacheFilmFields ( const areaFilm & film )

protectedvirtual

Cache the finite area film fields in preparation for injection.

Reimplemented from KinematicSurfaceFilm< CloudType >.

Definition at line 287 of file ThermoSurfaceFilm.C.

References KinematicSurfaceFilm< CloudType >::cacheFilmFields(), liquidFilmBase::Cp(), CpFilmPatch_, GeometricField< Type, PatchField, GeoMesh >::primitiveField(), liquidFilmBase::Tf(), and TFilmPatch_.

Here is the call graph for this function:

◆ setParcelProperties()

template<class CloudType>

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

protectedvirtual

Set the individual parcel properties.

Reimplemented from KinematicSurfaceFilm< CloudType >.

Definition at line 303 of file ThermoSurfaceFilm.C.

References CpFilmPatch_, p, KinematicSurfaceFilm< CloudType >::setParcelProperties(), and TFilmPatch_.

Here is the call graph for this function:

◆ TypeName()

template<class CloudType>

TypeName ( "thermoSurfaceFilm" )

Runtime type information.

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

Here is the call graph for this function:

◆ clone()

template<class CloudType>

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

inlinevirtual

Construct and return a clone using supplied owner cloud.

Reimplemented from KinematicSurfaceFilm< CloudType >.

Definition at line 148 of file ThermoSurfaceFilm.H.

References ThermoSurfaceFilm().

Here is the call graph for this function:

◆ absorbInteraction()

template<class CloudType>

template<class filmType>

void absorbInteraction	(	filmType &	film,
		const parcelType &	p,
		const polyPatch &	pp,
		const label	facei,
		const scalar	mass,
		bool &	keepParticle )

Absorb parcel into film.

Definition at line 60 of file ThermoSurfaceFilm.C.

References DebugInfo, Foam::endl(), Foam::mag(), SurfaceFilmModel< CloudType >::nParcelsTransferred(), CloudSubModelBase< CloudType >::owner(), p, pp(), SurfaceFilmModel< CloudType >::totalMassTransferred(), and Urel.

Referenced by transferParcel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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

Reimplemented from KinematicSurfaceFilm< CloudType >.

Definition at line 106 of file ThermoSurfaceFilm.C.

Here is the call graph for this function:

◆ info()

template<class CloudType>

void info ( )

virtual

Write surface film info.

Reimplemented from KinematicSurfaceFilm< CloudType >.

Definition at line 318 of file ThermoSurfaceFilm.C.

References KinematicSurfaceFilm< CloudType >::info().

Here is the call graph for this function:

Member Data Documentation

◆ thermo_

template<class CloudType>

const SLGThermo& thermo_

protected

Reference to the cloud thermo package.

Definition at line 80 of file ThermoSurfaceFilm.H.

Referenced by ThermoSurfaceFilm(), ThermoSurfaceFilm(), and transferParcel().

◆ TFilmPatch_

template<class CloudType>

scalarField TFilmPatch_

protected

Film temperature / patch face.

Definition at line 88 of file ThermoSurfaceFilm.H.

Referenced by cacheFilmFields(), cacheFilmFields(), setParcelProperties(), ThermoSurfaceFilm(), and ThermoSurfaceFilm().

◆ CpFilmPatch_

template<class CloudType>

scalarField CpFilmPatch_

protected

Film specific heat capacity / patch face.

Definition at line 93 of file ThermoSurfaceFilm.H.

Referenced by cacheFilmFields(), cacheFilmFields(), setParcelProperties(), ThermoSurfaceFilm(), and ThermoSurfaceFilm().

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

src/lagrangian/intermediate/submodels/Thermodynamic/SurfaceFilmModel/ThermoSurfaceFilm/ThermoSurfaceFilm.H
src/lagrangian/intermediate/submodels/Thermodynamic/SurfaceFilmModel/ThermoSurfaceFilm/ThermoSurfaceFilm.C

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ parcelType

◆ areaFilm

◆ regionFilm

Constructor & Destructor Documentation

◆ ThermoSurfaceFilm() [1/2]

◆ ThermoSurfaceFilm() [2/2]

◆ ~ThermoSurfaceFilm()

Member Function Documentation

◆ cacheFilmFields() [1/2]

◆ cacheFilmFields() [2/2]

◆ setParcelProperties()

◆ TypeName()

◆ clone()

◆ absorbInteraction()

◆ transferParcel()

◆ info()

Member Data Documentation

◆ thermo_

◆ TFilmPatch_

◆ CpFilmPatch_