Inheritance diagram for surfaceFilm:

Collaboration diagram for surfaceFilm:

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

	surfaceFilm (const word &sourceName, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from explicit source name and mesh. More...

	surfaceFilm (const surfaceFilm &)=delete
	Disallow default bitwise copy construction. More...

virtual wordList	addSupFields () const
	Return the list of fields for which the option adds source term. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

virtual void	correct ()
	Solve the Lagrangian surfaceFilm and update the sources. More...

virtual void	addSup (fvMatrix< scalar > &eqn, const word &fieldName) const
	Add source to continuity equation. More...

virtual void	addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const word &fieldName) const
	Add source to pressure or enthalpy equation. More...

virtual void	addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const word &fieldName) const
	Add source to momentum equation. More...

virtual void	topoChange (const polyTopoChangeMap &)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

virtual bool	movePoints ()
	Update for mesh motion. More...

void	operator= (const surfaceFilm &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from fvModel
	TypeName ("fvModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, fvModel, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh))

	fvModel (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components. More...

autoPtr< fvModel >	clone () const
	Return clone. More...

virtual	~fvModel ()
	Destructor. More...

const word &	name () const
	Return const access to the source name. More...

const fvMesh &	mesh () const
	Return const access to the mesh database. More...

const dictionary &	coeffs () const
	Return dictionary. More...

virtual bool	addsSupToField (const word &fieldName) const
	Return true if the fvModel adds a source term to the given. More...

	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_SUP)
	Add a source term to an equation. More...

	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_RHO_SUP)
	Add a source term to a compressible equation. More...

	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_ALPHA_RHO_SUP)
	Add a source term to a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field) const
	Return source for an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
	Return source for an equation with a specified name. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const
	Return source for a compressible equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
	Return source for a compressible equation with a specified name. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
	Return source for a phase equation with a specified name. More...

virtual void	preUpdateMesh ()
	Prepare for mesh update. More...

virtual bool	read (const dictionary &dict)
	Read source dictionary. More...

template<class Type , class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::dimensionSet	sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds, const AlphaRhoFieldType &alphaRho, const AlphaRhoFieldTypes &... alphaRhos)

template<class Type >
Foam::dimensionSet	sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds)

template<class Type , class ... AlphaRhoFieldTypes>
Foam::tmp< Foam::fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhos) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const

Additional Inherited Members
Static Public Member Functions inherited from fvModel
template<class Type , class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static dimensionSet	sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds, const AlphaRhoFieldType &alphaRho, const AlphaRhoFieldTypes &... alphaRhos)
	Return the dimensions of the matrix of a source term. More...

template<class Type >
static dimensionSet	sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds)
	Return the dimensions of the matrix of a source term (base. More...

static autoPtr< fvModel >	New (const word &name, const dictionary &dict, const fvMesh &mesh)
	Return a reference to the selected fvModel. More...

Protected Member Functions inherited from fvModel
template<class Type >
void	addSupType (fvMatrix< Type > &eqn, const word &fieldName) const
	Add a source term to an equation. More...

template<class Type >
void	addSupType (const volScalarField &rho, fvMatrix< Type > &eqn, const word &fieldName) const
	Add a source term to a compressible equation. More...

template<class Type >
void	addSupType (const volScalarField &alpha, const volScalarField &rho, fvMatrix< Type > &eqn, const word &fieldName) const
	Add a source term to a phase equation. More...

template<class Type , class ... AlphaRhoFieldTypes>
tmp< fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhos) const
	Return source for equation with specified name and dimensions. More...

Detailed Description

surfaceFilm fvModel

Usage

Example usage:

surfaceFilm
{
    type    surfaceFilm;
}

Source files

Definition at line 60 of file surfaceFilm.H.

Constructor & Destructor Documentation

◆ surfaceFilm() [1/2]

surfaceFilm	(	const word &	sourceName,
		const word &	modelType,
		const dictionary &	dict,
		const fvMesh &	mesh
	)

Construct from explicit source name and mesh.

Definition at line 53 of file surfaceFilm.C.

References composition, forAll, objectRegistry::foundObject(), IOobject::groupName(), Foam::name(), basicSpecieMixture::solve(), Y, and basicSpecieMixture::Y().

Here is the call graph for this function:

◆ surfaceFilm() [2/2]

surfaceFilm ( const surfaceFilm & )

delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ TypeName()

TypeName ( "surfaceFilm" )

Runtime type information.

◆ addSupFields()

Foam::wordList addSupFields ( ) const

virtual

Return the list of fields for which the option adds source term.

to the transport equation

Reimplemented from fvModel.

Definition at line 103 of file surfaceFilm.C.

◆ maxDeltaT()

Foam::scalar maxDeltaT ( ) const

virtual

Return the maximum time-step for stable operation.

Reimplemented from fvModel.

Definition at line 109 of file surfaceFilm.C.

◆ correct()

void correct ( )

virtual

Solve the Lagrangian surfaceFilm and update the sources.

Reimplemented from fvModel.

Definition at line 115 of file surfaceFilm.C.

References surfaceFilm::addSup(), mesh, and timeIndex.

Here is the call graph for this function:

◆ addSup() [1/3]

void addSup	(	fvMatrix< scalar > &	eqn,
		const word &	fieldName
	)		const

virtual

Add source to continuity equation.

Definition at line 129 of file surfaceFilm.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, IOobject::name(), fvMatrix< Type >::psi(), and Foam::type().

Referenced by surfaceFilm::addSup(), and surfaceFilm::correct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addSup() [2/3]

void addSup	(	const volScalarField &	rho,
		fvMatrix< scalar > &	eqn,
		const word &	fieldName
	)		const

virtual

Add source to pressure or enthalpy equation.

Definition at line 153 of file surfaceFilm.C.

References surfaceFilm::addSup(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, IOobject::name(), fvMatrix< Type >::psi(), and Foam::type().

Here is the call graph for this function:

◆ addSup() [3/3]

void addSup	(	const volScalarField &	rho,
		fvMatrix< vector > &	eqn,
		const word &	fieldName
	)		const

virtual

Add source to momentum equation.

Definition at line 197 of file surfaceFilm.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, IOobject::name(), fvMatrix< Type >::psi(), and Foam::type().

Here is the call graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap & )

virtual

Update topology using the given map.

Implements fvModel.

Definition at line 221 of file surfaceFilm.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Implements fvModel.

Definition at line 225 of file surfaceFilm.C.

◆ distribute()

void distribute ( const polyDistributionMap & )

virtual

Redistribute or update using the given distribution map.

Implements fvModel.

Definition at line 229 of file surfaceFilm.C.

◆ movePoints()

bool movePoints ( )

virtual

Update for mesh motion.

Implements fvModel.

Definition at line 233 of file surfaceFilm.C.

◆ operator=()

void operator= ( const surfaceFilm & )

delete

Disallow default bitwise assignment.

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

src/regionModels/surfaceFilmModels/fvModels/surfaceFilm/surfaceFilm.H
src/regionModels/surfaceFilmModels/fvModels/surfaceFilm/surfaceFilm.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ surfaceFilm() [1/2]

◆ surfaceFilm() [2/2]

Member Function Documentation

◆ TypeName()

◆ addSupFields()

◆ maxDeltaT()

◆ correct()

◆ addSup() [1/3]

◆ addSup() [2/3]

◆ addSup() [3/3]

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ movePoints()

◆ operator=()