Kinematic parcel surface film model. More...

#include <KinematicSurfaceFilm.H>

Inheritance diagram for KinematicSurfaceFilm< CloudType >:

[legend]

Collaboration diagram for KinematicSurfaceFilm< CloudType >:

[legend]

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

Public Member Functions
	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 autoPtr< SurfaceFilmModel< CloudType > >	clone () const
	Construct and return a clone using supplied owner cloud.
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.
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 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.

Static Public Attributes
static const Enum< interactionType >	interactionTypeNames
	Names for interactionType.

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 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
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.
virtual void	cacheFilmFields (const areaFilm &film)
	Cache the film fields in preparation for injection.
virtual void	cacheFilmFields (const label filmPatchi, const label primaryPatchi, const regionModels::surfaceFilmModels::surfaceFilmRegionModel &)
	Cache the 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 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
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
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.

Detailed Description

template<class CloudType>
class Foam::KinematicSurfaceFilm< CloudType >

Kinematic parcel surface film model.

Responsible for:

injecting parcels from the film model into the cloud, e.g. for dripping
parcel interaction with the film, e.g absorb, bounce, splash

Source files

Definition at line 71 of file KinematicSurfaceFilm.H.

Member Typedef Documentation

◆ parcelType

template<class CloudType>

typedef CloudType::parcelType parcelType

protected

Convenience typedef to the cloud's parcel type.

Definition at line 102 of file KinematicSurfaceFilm.H.

◆ areaFilm

template<class CloudType>

typedef regionModels::areaSurfaceFilmModels::liquidFilmBase areaFilm

protected

Definition at line 105 of file KinematicSurfaceFilm.H.

◆ regionFilm

template<class CloudType>

typedef regionModels::surfaceFilmModels::surfaceFilmRegionModel regionFilm

protected

Definition at line 108 of file KinematicSurfaceFilm.H.

Member Enumeration Documentation

◆ interactionType

template<class CloudType>

enum class interactionType

strong

Options for the interaction types.

Enumerator
absorb	absorb
bounce	bounce
splashBai	Bai splash model.

Definition at line 82 of file KinematicSurfaceFilm.H.

Constructor & Destructor Documentation

◆ KinematicSurfaceFilm() [1/2]

template<class CloudType>

KinematicSurfaceFilm	(	const dictionary &	dict,
		CloudType &	owner,
		const word &	type = typeName,
		bool	initThermo = true )

Construct from components.

Definition at line 470 of file KinematicSurfaceFilm.C.

References Adry_, areaFilms_, Awet_, Cf_, subModelBase::coeffDict(), deltaWet_, subModelBase::dict(), dMaxSplash_, dMinSplash_, Foam::endl(), filmModel_, dictionary::getOrDefault(), Foam::Info, init(), interactionType_, interactionTypeNames, nParcelsSplashed_, CloudSubModelBase< CloudType >::owner(), parcelsPerSplash_, parcelTypes_, dictionary::readEntry(), rndGen, rndGen_, splashBai, splashParcelType_, SurfaceFilmModel< CloudType >::SurfaceFilmModel(), thermo_, and Foam::Zero.

Referenced by clone(), KinematicSurfaceFilm(), ThermoSurfaceFilm< CloudType >::ThermoSurfaceFilm(), ThermoSurfaceFilm< CloudType >::ThermoSurfaceFilm(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ KinematicSurfaceFilm() [2/2]

template<class CloudType>

KinematicSurfaceFilm	(	const KinematicSurfaceFilm< CloudType > &	sfm,
		bool	initThermo = true )

Construct copy.

Definition at line 520 of file KinematicSurfaceFilm.C.

References Adry_, areaFilms_, Awet_, Cf_, deltaWet_, dMaxSplash_, dMinSplash_, filmModel_, init(), interactionType_, KinematicSurfaceFilm(), nParcelsSplashed_, parcelsPerSplash_, parcelTypes_, rndGen_, splashBai, splashParcelType_, SurfaceFilmModel< CloudType >::SurfaceFilmModel(), and thermo_.

Here is the call graph for this function:

◆ ~KinematicSurfaceFilm()

template<class CloudType>

virtual ~KinematicSurfaceFilm ( )

virtualdefault

Destructor.

References mu, p, pp(), and sigma().

Here is the call graph for this function:

Member Function Documentation

◆ tangentVector()

template<class CloudType>

Foam::vector tangentVector ( const vector & v ) const

protected

Return a vector tangential to input vector, v.

Definition at line 48 of file KinematicSurfaceFilm.C.

References Foam::mag(), rndGen_, and Foam::Zero.

Referenced by splashInteraction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ splashDirection()

template<class CloudType>

Foam::vector splashDirection	(	const vector &	tanVec1,
		const vector &	tanVec2,
		const vector &	nf ) const

protected

Return splashed parcel direction.

Definition at line 68 of file KinematicSurfaceFilm.C.

References alpha, Foam::cos(), Foam::degToRad(), Foam::mag(), rndGen_, Foam::sin(), and Foam::constant::mathematical::twoPi().

Referenced by splashInteraction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init()

template<class CloudType>

void init ( bool binitThermo )

protected

Initialise thermo.

Definition at line 117 of file KinematicSurfaceFilm.C.

References subModelBase::coeffDict(), pRef_, thermo_, and TRef_.

Referenced by KinematicSurfaceFilm(), and KinematicSurfaceFilm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFilmModels()

template<class CloudType>

void initFilmModels ( )

protected

Initialise pointers of films.

Definition at line 93 of file KinematicSurfaceFilm.C.

References areaFilms_, filmModel_, mesh, CloudSubModelBase< CloudType >::owner(), and SurfaceFilmModel< CloudType >::sorted_areaFilms().

Referenced by transferParcel(), and ThermoSurfaceFilm< CloudType >::transferParcel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cacheFilmFields() [1/2]

template<class CloudType>

void cacheFilmFields ( const areaFilm & film )

protectedvirtual

Cache the film fields in preparation for injection.

Reimplemented from SurfaceFilmModel< CloudType >.

Reimplemented in ThermoSurfaceFilm< CloudType >.

Definition at line 743 of file KinematicSurfaceFilm.C.

References SurfaceFilmModel< CloudType >::cacheFilmFields().

Referenced by ThermoSurfaceFilm< CloudType >::cacheFilmFields(), and ThermoSurfaceFilm< CloudType >::cacheFilmFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cacheFilmFields() [2/2]

template<class CloudType>

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

protectedvirtual

Cache the film fields in preparation for injection.

Reimplemented from SurfaceFilmModel< CloudType >.

Reimplemented in ThermoSurfaceFilm< CloudType >.

Definition at line 726 of file KinematicSurfaceFilm.C.

References SurfaceFilmModel< CloudType >::cacheFilmFields().

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

Reimplemented in ThermoSurfaceFilm< CloudType >.

Definition at line 753 of file KinematicSurfaceFilm.C.

References p, and SurfaceFilmModel< CloudType >::setParcelProperties().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

template<class CloudType>

TypeName ( "kinematicSurfaceFilm" )

Runtime type information.

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

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.

Implements SurfaceFilmModel< CloudType >.

Reimplemented in ThermoSurfaceFilm< CloudType >.

Definition at line 313 of file KinematicSurfaceFilm.H.

References KinematicSurfaceFilm().

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 130 of file KinematicSurfaceFilm.C.

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

Referenced by drySplashInteraction(), splashInteraction(), transferParcel(), and wetSplashInteraction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ bounceInteraction()

template<class CloudType>

void bounceInteraction	(	parcelType &	p,
		const polyPatch &	pp,
		const label	facei,
		bool &	keepParticle ) const

Bounce parcel (flip parcel normal velocity).

Definition at line 176 of file KinematicSurfaceFilm.C.

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

Referenced by transferParcel(), and ThermoSurfaceFilm< CloudType >::transferParcel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ drySplashInteraction()

template<class CloudType>

template<class filmType>

void drySplashInteraction	(	filmType &	filmModel,
		const scalar	sigma,
		const scalar	mu,
		const parcelType &	p,
		const polyPatch &	pp,
		const label	facei,
		bool &	keepParticle )

Parcel interaction with dry surface.

Definition at line 204 of file KinematicSurfaceFilm.C.

References absorbInteraction(), Adry_, DebugInfo, Foam::endl(), Foam::magSqr(), mu, CloudSubModelBase< CloudType >::owner(), p, Foam::pow(), pp(), rho, rndGen_, sigma(), splashInteraction(), Foam::sqr(), and Urel.

Referenced by transferParcel(), and ThermoSurfaceFilm< CloudType >::transferParcel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ wetSplashInteraction()

template<class CloudType>

template<class filmType>

void wetSplashInteraction	(	filmType &	filmModel,
		const scalar	sigma,
		const scalar	mu,
		parcelType &	p,
		const polyPatch &	pp,
		const label	facei,
		bool &	keepParticle )

Parcel interaction with wetted surface.

Definition at line 257 of file KinematicSurfaceFilm.C.

References absorbInteraction(), Foam::acos(), Awet_, DebugInfo, Foam::endl(), epsilon, Foam::mag(), Foam::magSqr(), mu, CloudSubModelBase< CloudType >::owner(), p, Foam::constant::mathematical::piByTwo(), Foam::pow(), pp(), rho, rndGen_, sigma(), splashInteraction(), Foam::sqr(), U, and Urel.

Referenced by transferParcel(), and ThermoSurfaceFilm< CloudType >::transferParcel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ splashInteraction()

template<class CloudType>

template<class filmType>

void splashInteraction	(	filmType &	filmModel,
		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.

Definition at line 329 of file KinematicSurfaceFilm.C.

References absorbInteraction(), Foam::cbrt(), Cf_, Foam::meshTools::constrainDirection(), dMaxSplash_, dMinSplash_, Foam::exp(), forAll, particle< Type >::getNewParticleID(), Foam::log(), Foam::mag(), Foam::magSqr(), Foam::max(), mesh, UPstream::myProcNo(), nParcelsSplashed_, particle< Type >::origId(), particle< Type >::origProc(), CloudSubModelBase< CloudType >::owner(), p, parcelsPerSplash_, Foam::constant::mathematical::pi(), Foam::pow3(), pp(), rndGen_, sigma(), splashDirection(), splashParcelType_, Foam::sqr(), Foam::sqrt(), tangentVector(), particle< Type >::track(), DSMCParcel< ParcelType >::typeId(), DSMCParcel< ParcelType >::U(), Urel, and y.

Referenced by drySplashInteraction(), and wetSplashInteraction().

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

Implements SurfaceFilmModel< CloudType >.

Reimplemented in ThermoSurfaceFilm< CloudType >.

Definition at line 553 of file KinematicSurfaceFilm.C.

References Foam::abort(), absorb, absorbInteraction(), areaFilms_, bounce, bounceInteraction(), SurfaceFilmModel< CloudType >::deltaFilmPatch_, deltaWet_, drySplashInteraction(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, filmModel_, initFilmModels(), interactionType_, mu, p, parcelTypes_, Foam::Pout, pp(), pRef_, Foam::refCast(), sigma(), splashBai, thermo_, TRef(), TRef_, and wetSplashInteraction().

Here is the call graph for this function:

◆ info()

template<class CloudType>

void info ( )

virtual

Write surface film info.

Reimplemented from SurfaceFilmModel< CloudType >.

Reimplemented in ThermoSurfaceFilm< CloudType >.

Definition at line 764 of file KinematicSurfaceFilm.C.

References Foam::endl(), subModelBase::getModelProperty(), SurfaceFilmModel< CloudType >::info(), Log_, nParcelsSplashed_, Foam::returnReduce(), subModelBase::setModelProperty(), and CloudSubModelBase< CloudType >::writeTime().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ interactionTypeNames

template<class CloudType>

const Foam::Enum< typename Foam::KinematicSurfaceFilm< CloudType >::interactionType > interactionTypeNames

static

Names for interactionType.

Definition at line 92 of file KinematicSurfaceFilm.H.

Referenced by KinematicSurfaceFilm().

◆ rndGen_

template<class CloudType>

Random& rndGen_

protected

Reference to the cloud random number generator.

Definition at line 116 of file KinematicSurfaceFilm.H.

Referenced by drySplashInteraction(), KinematicSurfaceFilm(), KinematicSurfaceFilm(), splashDirection(), splashInteraction(), tangentVector(), and wetSplashInteraction().

◆ thermo_

template<class CloudType>

liquidMixtureProperties* thermo_

protected

Region Film liquid thermo.

Definition at line 124 of file KinematicSurfaceFilm.H.

Referenced by init(), KinematicSurfaceFilm(), KinematicSurfaceFilm(), and transferParcel().

◆ pRef_

template<class CloudType>

scalar pRef_

protected

Region Film reference pressure.

Definition at line 129 of file KinematicSurfaceFilm.H.

Referenced by init(), and transferParcel().

◆ TRef_

template<class CloudType>

scalar TRef_

protected

Region Film reference temperature.

Definition at line 134 of file KinematicSurfaceFilm.H.

Referenced by init(), and transferParcel().

◆ filmModel_

template<class CloudType>

regionFilm* filmModel_

protected

Pointer to filmModel.

Definition at line 139 of file KinematicSurfaceFilm.H.

Referenced by initFilmModels(), KinematicSurfaceFilm(), KinematicSurfaceFilm(), transferParcel(), and ThermoSurfaceFilm< CloudType >::transferParcel().

◆ areaFilms_

template<class CloudType>

UPtrList<areaFilm> areaFilms_

protected

UPointers to area films.

Definition at line 147 of file KinematicSurfaceFilm.H.

Referenced by initFilmModels(), KinematicSurfaceFilm(), KinematicSurfaceFilm(), transferParcel(), and ThermoSurfaceFilm< CloudType >::transferParcel().

◆ interactionType_

template<class CloudType>

interactionType interactionType_

protected

Interaction type enumeration.

Definition at line 155 of file KinematicSurfaceFilm.H.

Referenced by KinematicSurfaceFilm(), KinematicSurfaceFilm(), transferParcel(), and ThermoSurfaceFilm< CloudType >::transferParcel().

◆ parcelTypes_

template<class CloudType>

labelList parcelTypes_

protected

Particle type IDs that can interact with the film.

If empty (default) all type IDs are included

Definition at line 162 of file KinematicSurfaceFilm.H.

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

◆ deltaWet_

template<class CloudType>

scalar deltaWet_

protected

Film thickness beyond which patch is assumed to be wet.

Definition at line 167 of file KinematicSurfaceFilm.H.

Referenced by KinematicSurfaceFilm(), KinematicSurfaceFilm(), transferParcel(), and ThermoSurfaceFilm< CloudType >::transferParcel().

◆ splashParcelType_

template<class CloudType>

label splashParcelType_

protected

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

post-processing. If not specified, defaults to originating cloud type

Definition at line 175 of file KinematicSurfaceFilm.H.

Referenced by KinematicSurfaceFilm(), KinematicSurfaceFilm(), and splashInteraction().

◆ parcelsPerSplash_

template<class CloudType>

label parcelsPerSplash_

protected

Number of new parcels resulting from splash event.

Definition at line 180 of file KinematicSurfaceFilm.H.

Referenced by KinematicSurfaceFilm(), KinematicSurfaceFilm(), and splashInteraction().

◆ dMaxSplash_

template<class CloudType>

scalar dMaxSplash_

protected

Maximum splash particle diameter for Chi-square distribution.

Default is incident particle diameter

Definition at line 187 of file KinematicSurfaceFilm.H.

Referenced by KinematicSurfaceFilm(), KinematicSurfaceFilm(), and splashInteraction().

◆ dMinSplash_

template<class CloudType>

scalar dMinSplash_

protected

Minimum splash particle diameter for Chi-square distribution.

Default is 0.1 dMaxSplash

Definition at line 194 of file KinematicSurfaceFilm.H.

Referenced by KinematicSurfaceFilm(), KinematicSurfaceFilm(), and splashInteraction().

◆ Adry_

template<class CloudType>

scalar Adry_

protected

Dry surface roughness coefficient.

= 2630 for dry interaction (ref. Bai)

Definition at line 204 of file KinematicSurfaceFilm.H.

Referenced by drySplashInteraction(), KinematicSurfaceFilm(), and KinematicSurfaceFilm().

◆ Awet_

template<class CloudType>

scalar Awet_

protected

Wet surface roughness coefficient.

= 1320 for wet interaction (ref. Bai)

Definition at line 211 of file KinematicSurfaceFilm.H.

Referenced by KinematicSurfaceFilm(), KinematicSurfaceFilm(), and wetSplashInteraction().

◆ Cf_

template<class CloudType>

scalar Cf_

protected

Skin friction typically in the range 0.6 < Cf < 0.8.

Definition at line 217 of file KinematicSurfaceFilm.H.

Referenced by KinematicSurfaceFilm(), KinematicSurfaceFilm(), and splashInteraction().

◆ nParcelsSplashed_

template<class CloudType>

label nParcelsSplashed_

protected

Counter for number of new splash parcels.

Definition at line 222 of file KinematicSurfaceFilm.H.

Referenced by info(), KinematicSurfaceFilm(), KinematicSurfaceFilm(), and splashInteraction().

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

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

Public Types

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ parcelType

◆ areaFilm

◆ regionFilm

Member Enumeration Documentation

◆ interactionType

Constructor & Destructor Documentation

◆ KinematicSurfaceFilm() [1/2]

◆ KinematicSurfaceFilm() [2/2]

◆ ~KinematicSurfaceFilm()

Member Function Documentation

◆ tangentVector()

◆ splashDirection()

◆ init()

◆ initFilmModels()

◆ cacheFilmFields() [1/2]

◆ cacheFilmFields() [2/2]

◆ setParcelProperties()

◆ TypeName()

◆ clone()

◆ absorbInteraction()

◆ bounceInteraction()

◆ drySplashInteraction()

◆ wetSplashInteraction()

◆ splashInteraction()

◆ transferParcel()

◆ info()

Member Data Documentation

◆ interactionTypeNames

◆ rndGen_

◆ thermo_

◆ pRef_

◆ TRef_

◆ filmModel_

◆ areaFilms_

◆ interactionType_

◆ parcelTypes_

◆ deltaWet_

◆ splashParcelType_

◆ parcelsPerSplash_

◆ dMaxSplash_

◆ dMinSplash_

◆ Adry_

◆ Awet_

◆ Cf_

◆ nParcelsSplashed_