Thermo parcel surface film model. More...

Inheritance diagram for ThermoSurfaceFilm< CloudType >:

Collaboration diagram for ThermoSurfaceFilm< CloudType >:

Public Member Functions
	TypeName ("thermoSurfaceFilm")
	Runtime type information. More...

	ThermoSurfaceFilm (const dictionary &dict, CloudType &owner)
	Construct from components. More...

	ThermoSurfaceFilm (const ThermoSurfaceFilm< CloudType > &sfm)
	Construct copy. More...

virtual autoPtr< SurfaceFilmModel< CloudType > >	clone () const
	Construct and return a clone using supplied owner cloud. More...

virtual	~ThermoSurfaceFilm ()=default
	Destructor. More...

virtual bool	transferParcel (parcelType &p, const polyPatch &pp, bool &keepParticle)
	Transfer parcel from cloud to surface film. More...

virtual void	info (Ostream &os)
	Write surface film info to stream. More...

Public Member Functions inherited from KinematicSurfaceFilm< CloudType >
interactionType	interactionTypeEnum (const word &it) const
	Return interaction type enum from word. More...

word	interactionTypeStr (const interactionType &it) const
	Return word from interaction type enum. More...

	TypeName ("kinematicSurfaceFilm")
	Runtime type information. More...

	KinematicSurfaceFilm (const dictionary &dict, CloudType &owner, const word &type=typeName, bool initThermo=true)
	Construct from components. More...

	KinematicSurfaceFilm (const KinematicSurfaceFilm< CloudType > &sfm, bool initThermo=true)
	Construct copy. More...

virtual	~KinematicSurfaceFilm ()=default
	Destructor. More...

template<class filmType >
void	absorbInteraction (filmType &, const parcelType &p, const polyPatch &pp, const label facei, const scalar mass, bool &keepParticle)
	Absorb parcel into film. More...

void	bounceInteraction (parcelType &p, const polyPatch &pp, const label facei, bool &keepParticle) const
	Bounce parcel (flip parcel normal velocity) More...

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

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

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

Public Member Functions inherited from SurfaceFilmModel< CloudType >
	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	~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...

template<class TrackCloudType >
void	inject (TrackCloudType &cloud)
	Inject parcels into the cloud. More...

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

Protected Types
typedef CloudType::parcelType	parcelType
	Convenience typedef to the cloud's parcel type. More...

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

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

typedef regionModels::areaSurfaceFilmModels::liquidFilmBase	areaFilm

Protected Member Functions
virtual void	cacheFilmFields (const label primaryPatchi, const areaFilm &)
	Cache the film fields in preparation for injection. More...

virtual void	cacheFilmFields (const label filmPatchi, const label primaryPatchi, const regionFilm &)
	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 Member Functions inherited from KinematicSurfaceFilm< CloudType >
vector	tangentVector (const vector &v) const
	Return a vector tangential to input vector, v. More...

vector	splashDirection (const vector &tanVec1, const vector &tanVec2, const vector &nf) const
	Return splashed parcel direction. More...

void	init (bool binitThermo)
	Initialise thermo. More...

void	initFilmModels ()
	Initialise pointers of films. More...

Protected Member Functions inherited from SurfaceFilmModel< CloudType >
template<class TrackCloudType >
void	injectParticles (const label primaryPatchi, const labelList &injectorCellsPatch, TrackCloudType &cloud)
	Inject particles in cloud. More...

Protected Attributes
const SLGThermo &	thermo_
	Reference to the cloud thermo package. More...

scalarField	TFilmPatch_
	Film temperature / patch face. More...

scalarField	CpFilmPatch_
	Film specific heat capacity / patch face. More...

Protected Attributes inherited from KinematicSurfaceFilm< CloudType >
Random &	rndGen_
	Reference to the cloud random number generator. More...

liquidMixtureProperties *	thermo_
	Region Film liquid thermo. More...

scalar	pRef_
	Region Film reference pressure. More...

scalar	TRef_
	Region Film reference temperature. More...

regionFilm *	filmModel_
	Pointer to filmModel. More...

UPtrList< areaFilm >	areaFilms_
	UPointers to area films. More...

interactionType	interactionType_
	Interaction type enumeration. More...

scalar	deltaWet_
	Film thickness beyond which patch is assumed to be wet. More...

label	splashParcelType_
	Splash parcel type label - id assigned to identify parcel for. More...

label	parcelsPerSplash_
	Number of new parcels resulting from splash event. More...

scalar	Adry_
	Dry surface roughness coefficient. More...

scalar	Awet_
	Wet surface roughness coefficient. More...

scalar	Cf_
	Skin friction typically in the range 0.6 < Cf < 0.8. More...

label	nParcelsSplashed_
	Counter for number of new splash parcels. More...

Protected Attributes inherited from SurfaceFilmModel< CloudType >
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...

Additional Inherited Members
Public Types inherited from KinematicSurfaceFilm< CloudType >
enum	interactionType { itAbsorb, itBounce, itSplashBai }
	Options for the interaction types. More...

Static Public Member Functions inherited from SurfaceFilmModel< CloudType >
static autoPtr< SurfaceFilmModel< CloudType > >	New (const dictionary &dict, CloudType &owner)
	Selector. More...

Static Public Attributes inherited from KinematicSurfaceFilm< CloudType >
static wordList	interactionTypeNames_
	Names for interactionType. More...

Detailed Description

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

Thermo parcel surface film model.

Source files

Definition at line 57 of file ThermoSurfaceFilm.H.

Member Typedef Documentation

◆ parcelType

typedef CloudType::parcelType parcelType

protected

Convenience typedef to the cloud's parcel type.

Definition at line 66 of file ThermoSurfaceFilm.H.

◆ areaFilm

typedef regionModels::areaSurfaceFilmModels::liquidFilmBase areaFilm

protected

Definition at line 69 of file ThermoSurfaceFilm.H.

◆ regionFilm

typedef regionModels::surfaceFilmModels::surfaceFilmRegionModel regionFilm

protected

Definition at line 72 of file ThermoSurfaceFilm.H.

Constructor & Destructor Documentation

◆ ThermoSurfaceFilm() [1/2]

ThermoSurfaceFilm	(	const dictionary &	dict,
		CloudType &	owner
	)

Construct from components.

Definition at line 35 of file ThermoSurfaceFilm.C.

◆ ThermoSurfaceFilm() [2/2]

ThermoSurfaceFilm ( const ThermoSurfaceFilm< CloudType > & sfm )

Construct copy.

Definition at line 52 of file ThermoSurfaceFilm.C.

◆ ~ThermoSurfaceFilm()

virtual ~ThermoSurfaceFilm ( )

virtualdefault

Destructor.

Member Function Documentation

◆ cacheFilmFields() [1/2]

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

protectedvirtual

Cache the film fields in preparation for injection.

Reimplemented from KinematicSurfaceFilm< CloudType >.

Definition at line 229 of file ThermoSurfaceFilm.C.

References liquidFilmBase::Cp(), volSurfaceMapping::mapToField(), liquidFilmBase::region(), liquidFilmBase::Tf(), regionFaModel::vsm(), and Foam::Zero.

Here is the call graph for this function:

◆ cacheFilmFields() [2/2]

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 206 of file ThermoSurfaceFilm.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), surfaceFilmRegionModel::Cp(), regionModel::toPrimary(), and surfaceFilmRegionModel::Ts().

Here is the call graph for this function:

◆ setParcelProperties()

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

protectedvirtual

Set the individual parcel properties.

Reimplemented from KinematicSurfaceFilm< CloudType >.

Definition at line 250 of file ThermoSurfaceFilm.C.

References p.

◆ TypeName()

TypeName ( "thermoSurfaceFilm" )

Runtime type information.

◆ clone()

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

inlinevirtual

Construct and return a clone using supplied owner cloud.

Reimplemented from KinematicSurfaceFilm< CloudType >.

Definition at line 128 of file ThermoSurfaceFilm.H.

◆ transferParcel()

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 67 of file ThermoSurfaceFilm.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, patchIdentifier::index(), Foam::constant::physicoChemical::mu, liquidProperties::mu(), p, sigma(), liquidProperties::sigma(), and polyPatch::whichFace().

Here is the call graph for this function:

◆ info()

void info ( Ostream & os )

virtual

Write surface film info to stream.

Reimplemented from KinematicSurfaceFilm< CloudType >.

Definition at line 264 of file ThermoSurfaceFilm.C.

References os().

Here is the call graph for this function:

Member Data Documentation

◆ thermo_

const SLGThermo& thermo_

protected

Reference to the cloud thermo package.

Definition at line 75 of file ThermoSurfaceFilm.H.

◆ TFilmPatch_

scalarField TFilmPatch_

protected

Film temperature / patch face.

Definition at line 81 of file ThermoSurfaceFilm.H.

◆ CpFilmPatch_

scalarField CpFilmPatch_

protected

Film specific heat capacity / patch face.

Definition at line 84 of file ThermoSurfaceFilm.H.

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

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

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()

◆ transferParcel()

◆ info()

Member Data Documentation

◆ thermo_

◆ TFilmPatch_

◆ CpFilmPatch_

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