KinematicSurfaceFilm< CloudType > Class Template Reference

Kinematic parcel surface film model. More...

Inheritance diagram for KinematicSurfaceFilm< CloudType >:

Collaboration diagram for KinematicSurfaceFilm< CloudType >:

Public Types
enum	interactionType { itAbsorb, itBounce, itSplashBai }

Public Member Functions
interactionType	interactionTypeEnum (const word &it) const
word	interactionTypeStr (const interactionType &it) const
	TypeName ("kinematicSurfaceFilm")
	KinematicSurfaceFilm (const dictionary &dict, CloudType &owner, const word &type=typeName, bool initThermo=true)
	KinematicSurfaceFilm (const KinematicSurfaceFilm< CloudType > &sfm, bool initThermo=true)
virtual autoPtr< SurfaceFilmModel< CloudType > >	clone () const
virtual	~KinematicSurfaceFilm ()=default
template<class filmType >
void	absorbInteraction (filmType &, const parcelType &p, const polyPatch &pp, const label facei, const scalar mass, bool &keepParticle)
void	bounceInteraction (parcelType &p, const polyPatch &pp, const label facei, bool &keepParticle) const
template<class filmType >
void	drySplashInteraction (filmType &, const scalar sigma, const scalar mu, const parcelType &p, const polyPatch &pp, const label facei, bool &keepParticle)
template<class filmType >
void	wetSplashInteraction (filmType &, const scalar sigma, const scalar mu, parcelType &p, const polyPatch &pp, const label facei, bool &keepParticle)
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)
virtual bool	transferParcel (parcelType &p, const polyPatch &pp, bool &keepParticle)
virtual void	info (Ostream &os)
Public Member Functions inherited from SurfaceFilmModel< CloudType >
void	injectParticles (const label primaryPatchi, const labelList &injectorCellsPatch, CloudTrackType &cloud)
	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
void	inject (TrackCloudType &cloud)

Static Public Attributes
static wordList	interactionTypeNames_

Protected Types
typedef CloudType::parcelType	parcelType
typedef regionModels::areaSurfaceFilmModels::liquidFilmBase	areaFilm
typedef regionModels::surfaceFilmModels::surfaceFilmRegionModel	regionFilm
Protected Types inherited from SurfaceFilmModel< CloudType >
typedef CloudType::parcelType	parcelType
typedef regionModels::areaSurfaceFilmModels::liquidFilmBase	areaFilm

Protected Member Functions
vector	tangentVector (const vector &v) const
vector	splashDirection (const vector &tanVec1, const vector &tanVec2, const vector &nf) const
void	init (bool binitThermo)
void	initFilmModels ()
virtual void	cacheFilmFields (const label primaryPatchi, const areaFilm &)
virtual void	cacheFilmFields (const label filmPatchi, const label primaryPatchi, const regionModels::surfaceFilmModels::surfaceFilmRegionModel &)
virtual void	setParcelProperties (parcelType &p, const label filmFacei) const
Protected Member Functions inherited from SurfaceFilmModel< CloudType >
void	injectParticles (const label primaryPatchi, const labelList &injectorCellsPatch, TrackCloudType &cloud)

Protected Attributes
Random &	rndGen_
liquidMixtureProperties *	thermo_
scalar	pRef_
scalar	TRef_
regionFilm *	filmModel_
UPtrList< areaFilm >	areaFilms_
interactionType	interactionType_
scalar	deltaWet_
label	splashParcelType_
label	parcelsPerSplash_
scalar	Adry_
scalar	Awet_
scalar	Cf_
label	nParcelsSplashed_
Protected Attributes inherited from SurfaceFilmModel< CloudType >
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_

Additional Inherited Members
Static Public Member Functions inherited from SurfaceFilmModel< CloudType >
static autoPtr< SurfaceFilmModel< CloudType > >	New (const dictionary &dict, CloudType &owner)

Detailed Description

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

Kinematic parcel surface film model.

Responsible for:

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

Source files

• KinematicSurfaceFilm.H
• KinematicSurfaceFilm.C
• KinematicSurfaceFilmI.H

Definition at line 74 of file KinematicSurfaceFilm.H.

Member Typedef Documentation

parcelType

typedef CloudType::parcelType parcelType

protected

Definition at line 108 of file KinematicSurfaceFilm.H.

areaFilm

typedef regionModels::areaSurfaceFilmModels::liquidFilmBase areaFilm

protected

Definition at line 111 of file KinematicSurfaceFilm.H.

regionFilm

typedef regionModels::surfaceFilmModels::surfaceFilmRegionModel regionFilm

protected

Definition at line 114 of file KinematicSurfaceFilm.H.

Member Enumeration Documentation

interactionType

enum interactionType

Enumerator
itAbsorb
itBounce
itSplashBai

Definition at line 83 of file KinematicSurfaceFilm.H.

Constructor & Destructor Documentation

KinematicSurfaceFilm() [1/2]

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

Definition at line 537 of file KinematicSurfaceFilm.C.

References Foam::endl(), Foam::Info, and init().

Here is the call graph for this function:

KinematicSurfaceFilm() [2/2]

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

Definition at line 581 of file KinematicSurfaceFilm.C.

References init().

Here is the call graph for this function:

~KinematicSurfaceFilm()

virtual ~KinematicSurfaceFilm ( )

virtualdefault

Member Function Documentation

interactionTypeEnum()

Foam::KinematicSurfaceFilm< CloudType >::interactionType interactionTypeEnum

(

const word &

it

)

const

Definition at line 43 of file KinematicSurfaceFilm.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and forAll.

Here is the call graph for this function:

interactionTypeStr()

Foam::word interactionTypeStr

(

const interactionType &

it

)

const

Definition at line 64 of file KinematicSurfaceFilm.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

tangentVector()

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

protected

Definition at line 82 of file KinematicSurfaceFilm.C.

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

Here is the call graph for this function:

splashDirection()

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

protected

Definition at line 102 of file KinematicSurfaceFilm.C.

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

Here is the call graph for this function:

init()

void init ( bool  binitThermo )

protected

Definition at line 173 of file KinematicSurfaceFilm.C.

initFilmModels()

void initFilmModels

protected

Definition at line 126 of file KinematicSurfaceFilm.C.

References forAll, mesh, Foam::PtrListOps::names(), and fvMesh::time().

Here is the call graph for this function:

cacheFilmFields() [1/2]

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

protectedvirtual

Reimplemented from SurfaceFilmModel< CloudType >.

Reimplemented in ThermoSurfaceFilm< CloudType >.

Definition at line 773 of file KinematicSurfaceFilm.C.

References SurfaceFilmModel::cacheFilmFields().

Here is the call graph for this function:

cacheFilmFields() [2/2]

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

protectedvirtual

Reimplemented from SurfaceFilmModel< CloudType >.

Reimplemented in ThermoSurfaceFilm< CloudType >.

Definition at line 756 of file KinematicSurfaceFilm.C.

References SurfaceFilmModel::cacheFilmFields().

Here is the call graph for this function:

setParcelProperties()

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

protectedvirtual

Reimplemented from SurfaceFilmModel< CloudType >.

Reimplemented in ThermoSurfaceFilm< CloudType >.

Definition at line 788 of file KinematicSurfaceFilm.C.

References p, and SurfaceFilmModel::setParcelProperties().

Here is the call graph for this function:

TypeName()

TypeName

(

"kinematicSurfaceFilm"

)

clone()

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

inlinevirtual

Reimplemented in ThermoSurfaceFilm< CloudType >.

Definition at line 247 of file KinematicSurfaceFilm.H.

absorbInteraction()

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

Definition at line 187 of file KinematicSurfaceFilm.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), PrimitivePatch< FaceList, PointField >::faceNormals(), patchIdentifier::index(), Foam::Info, Foam::mag(), p, and Urel.

Here is the call graph for this function:

bounceInteraction()

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

Definition at line 236 of file KinematicSurfaceFilm.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), PrimitivePatch< FaceList, PointField >::faceNormals(), patchIdentifier::index(), Foam::Info, p, and Urel.

Here is the call graph for this function:

drySplashInteraction()

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

Definition at line 267 of file KinematicSurfaceFilm.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), PrimitivePatch< FaceList, PointField >::faceNormals(), patchIdentifier::index(), Foam::Info, Foam::magSqr(), Foam::constant::physicoChemical::mu, p, Foam::pow(), rho, sigma(), Foam::sqr(), and Urel.

Here is the call graph for this function:

wetSplashInteraction()

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

Definition at line 323 of file KinematicSurfaceFilm.C.

References Foam::acos(), Foam::expressions::patchExpr::debug, Foam::endl(), epsilon, PrimitivePatch< FaceList, PointField >::faceNormals(), patchIdentifier::index(), Foam::Info, Foam::mag(), Foam::magSqr(), Foam::constant::physicoChemical::mu, p, Foam::constant::mathematical::piByTwo(), Foam::pow(), rho, sigma(), Foam::sqr(), U, and Urel.

Here is the call graph for this function:

splashInteraction()

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
	)

Definition at line 398 of file KinematicSurfaceFilm.C.

References GeometricField::boundaryField(), fvMesh::C(), Foam::cbrt(), fvMesh::Cf(), Foam::meshTools::constrainDirection(), Foam::exp(), PrimitivePatch< FaceList, PointField >::faceNormals(), forAll, patchIdentifier::index(), Foam::log(), Foam::mag(), Foam::magSqr(), Foam::max(), mesh, UPstream::myProcNo(), p, Foam::constant::mathematical::pi(), Foam::pow3(), sigma(), polyMesh::solutionD(), Foam::sqr(), Foam::sqrt(), Urel, and y.

Here is the call graph for this function:

transferParcel()

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

virtual

Implements SurfaceFilmModel< CloudType >.

Reimplemented in ThermoSurfaceFilm< CloudType >.

Definition at line 611 of file KinematicSurfaceFilm.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, patchIdentifier::index(), Foam::constant::physicoChemical::mu, liquidMixtureProperties::mu(), p, Foam::refCast(), sigma(), liquidMixtureProperties::sigma(), liquidMixtureProperties::size(), liquidFilmModel::thermo(), TRef(), liquidFilmModel::Tref(), and polyPatch::whichFace().

Here is the call graph for this function:

info()

void info ( Ostream &  os )

virtual

Reimplemented from SurfaceFilmModel< CloudType >.

Reimplemented in ThermoSurfaceFilm< CloudType >.

Definition at line 798 of file KinematicSurfaceFilm.C.

References Foam::endl(), SurfaceFilmModel::info(), os(), and Foam::returnReduce().

Here is the call graph for this function:

Member Data Documentation

interactionTypeNames_

Foam::wordList interactionTypeNames_

static

Initial value:

{
    "absorb", "bounce", "splashBai"
}

Definition at line 91 of file KinematicSurfaceFilm.H.

rndGen_

Random& rndGen_

protected

Definition at line 117 of file KinematicSurfaceFilm.H.

thermo_

liquidMixtureProperties* thermo_

protected

Definition at line 123 of file KinematicSurfaceFilm.H.

pRef_

scalar pRef_

protected

Definition at line 126 of file KinematicSurfaceFilm.H.

TRef_

scalar TRef_

protected

Definition at line 129 of file KinematicSurfaceFilm.H.

filmModel_

regionFilm* filmModel_

protected

Definition at line 132 of file KinematicSurfaceFilm.H.

areaFilms_

UPtrList<areaFilm> areaFilms_

protected

Definition at line 138 of file KinematicSurfaceFilm.H.

interactionType_

interactionType interactionType_

protected

Definition at line 144 of file KinematicSurfaceFilm.H.

deltaWet_

scalar deltaWet_

protected

Definition at line 147 of file KinematicSurfaceFilm.H.

splashParcelType_

label splashParcelType_

protected

Definition at line 152 of file KinematicSurfaceFilm.H.

parcelsPerSplash_

label parcelsPerSplash_

protected

Definition at line 155 of file KinematicSurfaceFilm.H.

Adry_

scalar Adry_

protected

Definition at line 163 of file KinematicSurfaceFilm.H.

Awet_

scalar Awet_

protected

Definition at line 167 of file KinematicSurfaceFilm.H.

Cf_

scalar Cf_

protected

Definition at line 171 of file KinematicSurfaceFilm.H.

nParcelsSplashed_

label nParcelsSplashed_

protected

Definition at line 174 of file KinematicSurfaceFilm.H.

---

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