Abstract base class for alphaContactAngle boundary conditions. More...

Inheritance diagram for alphaContactAngleFvPatchScalarField:

[legend]

Collaboration diagram for alphaContactAngleFvPatchScalarField:

Classes
class	interfaceThetaProps

Public Types
enum	limitControls { lcNone, lcGradient, lcZeroGradient, lcAlpha }
	Alpha limit options. More...

typedef HashTable< interfaceThetaProps, multiphaseMixtureThermo::interfacePair, multiphaseMixtureThermo::interfacePair::hash >	thetaPropsTable

typedef HashTable< interfaceThetaProps, phasePairKey, phasePairKey::hash >	thetaPropsTable

typedef HashTable< interfaceThetaProps, multiphaseMixture::interfacePair, multiphaseMixture::interfacePair::hash >	thetaPropsTable

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

	alphaContactAngleFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field. More...

	alphaContactAngleFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given alphaContactAngleFvPatchScalarField. More...

	alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &)
	Copy constructor. More...

	alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Copy constructor setting internal field reference. More...

virtual tmp< scalarField >	theta (const fvPatchVectorField &Up, const fvsPatchVectorField &nHat) const =0
	Return the contact angle. More...

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
	Evaluate the patch field. More...

virtual void	write (Ostream &) const
	Write. More...

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

	alphaContactAngleFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field. More...

	alphaContactAngleFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given alphaContactAngleFvPatchScalarField. More...

virtual tmp< fvPatchScalarField >	clone () const
	Construct and return a clone. More...

	alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchScalarField >	clone (const DimensionedField< scalar, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

const thetaPropsTable &	thetaProps () const
	Return the contact angle properties. More...

virtual void	write (Ostream &) const
	Write. More...

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

	alphaContactAngleFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field. More...

	alphaContactAngleFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given alphaContactAngleFvPatchScalarField. More...

virtual tmp< fvPatchScalarField >	clone () const
	Construct and return a clone. More...

	alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchScalarField >	clone (const DimensionedField< scalar, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

const thetaPropsTable &	thetaProps () const
	Return the contact angle properties. More...

virtual void	write (Ostream &) const
	Write. More...

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

	alphaContactAngleFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field. More...

	alphaContactAngleFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given alphaContactAngleFvPatchScalarField. More...

virtual tmp< fvPatchScalarField >	clone () const
	Construct and return a clone. More...

	alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchScalarField >	clone (const DimensionedField< scalar, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

const thetaPropsTable &	thetaProps () const
	Return the contact angle properties. More...

virtual void	write (Ostream &) const
	Write. More...

Public Attributes
limitControls	limit_

Static Public Attributes
static const NamedEnum< limitControls, 4 >	limitControlNames_

Detailed Description

Abstract base class for alphaContactAngle boundary conditions.

Contact-angle boundary condition for multi-phase interface-capturing simulations. Used in conjunction with phaseSystem.

Contact-angle boundary condition for multi-phase interface-capturing simulations. Used in conjunction with multiphaseMixture.

Derived classes must implement the theta() function which returns the wall contact angle field.

The essential entry "limit" controls the gradient of alpha1 on the wall:

none - Calculate the gradient from the contact-angle without limiter
gradient - Limit the wall-gradient such that alpha1 remains bounded on the wall
alpha - Bound the calculated alpha1 on the wall
zeroGradient - Set the gradient of alpha1 to 0 on the wall, i.e. reproduce previous behaviour, the pressure BCs can be left as before.

Note that if any of the first three options are used the boundary condition on p_rgh must set to guarantee that the flux is corrected to be zero at the wall e.g.:

<patchName>
{
    type            alphaContactAngle;
    limit           none;
}

Source files

Definition at line 72 of file alphaContactAngleFvPatchScalarField.H.

Member Typedef Documentation

◆ thetaPropsTable [1/3]

typedef HashTable< interfaceThetaProps, multiphaseMixtureThermo::interfacePair, multiphaseMixtureThermo::interfacePair::hash > thetaPropsTable

Definition at line 121 of file alphaContactAngleFvPatchScalarField.H.

◆ thetaPropsTable [2/3]

typedef HashTable< interfaceThetaProps, phasePairKey, phasePairKey::hash > thetaPropsTable

Definition at line 121 of file alphaContactAngleFvPatchScalarField.H.

◆ thetaPropsTable [3/3]

typedef HashTable< interfaceThetaProps, multiphaseMixture::interfacePair, multiphaseMixture::interfacePair::hash > thetaPropsTable

Definition at line 121 of file alphaContactAngleFvPatchScalarField.H.

Member Enumeration Documentation

◆ limitControls

enum limitControls

Alpha limit options.

Enumerator
lcNone
lcGradient
lcZeroGradient
lcAlpha

Definition at line 83 of file alphaContactAngleFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ alphaContactAngleFvPatchScalarField() [1/17]

alphaContactAngleFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 62 of file alphaContactAngleFvPatchScalarField.C.

Referenced by alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField(), alphaContactAngleFvPatchScalarField::clone(), and NamedEnum< compressibleField, 8 >::names().

Here is the caller graph for this function:

◆ alphaContactAngleFvPatchScalarField() [2/17]

alphaContactAngleFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 73 of file alphaContactAngleFvPatchScalarField.C.

References alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField(), dictionary::found(), fvPatchField< Type >::operator=(), and fvPatch::size().

Here is the call graph for this function:

◆ alphaContactAngleFvPatchScalarField() [3/17]

alphaContactAngleFvPatchScalarField	(	const alphaContactAngleFvPatchScalarField &	acpsf,
		const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping given alphaContactAngleFvPatchScalarField.

onto a new patch

Definition at line 97 of file alphaContactAngleFvPatchScalarField.C.

References alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField().

Here is the call graph for this function:

◆ alphaContactAngleFvPatchScalarField() [4/17]

alphaContactAngleFvPatchScalarField ( const alphaContactAngleFvPatchScalarField & acpsf )

Copy constructor.

Definition at line 110 of file alphaContactAngleFvPatchScalarField.C.

References alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField().

Here is the call graph for this function:

◆ alphaContactAngleFvPatchScalarField() [5/17]

alphaContactAngleFvPatchScalarField	(	const alphaContactAngleFvPatchScalarField &	acpsf,
		const DimensionedField< scalar, volMesh > &	iF
	)

Copy constructor setting internal field reference.

Definition at line 120 of file alphaContactAngleFvPatchScalarField.C.

References alphaContactAngleFvPatchScalarField::evaluate().

Here is the call graph for this function:

◆ alphaContactAngleFvPatchScalarField() [6/17]

alphaContactAngleFvPatchScalarField	(	const fvPatch &	,
		const DimensionedField< scalar, volMesh > &
	)

Construct from patch and internal field.

◆ alphaContactAngleFvPatchScalarField() [7/17]

alphaContactAngleFvPatchScalarField	(	const fvPatch &	,
		const DimensionedField< scalar, volMesh > &	,
		const dictionary &
	)

Construct from patch, internal field and dictionary.

◆ alphaContactAngleFvPatchScalarField() [8/17]

alphaContactAngleFvPatchScalarField	(	const alphaContactAngleFvPatchScalarField &	,
		const fvPatch &	,
		const DimensionedField< scalar, volMesh > &	,
		const fvPatchFieldMapper &
	)

Construct by mapping given alphaContactAngleFvPatchScalarField.

onto a new patch

◆ alphaContactAngleFvPatchScalarField() [9/17]

alphaContactAngleFvPatchScalarField	(	const alphaContactAngleFvPatchScalarField &	,
		const DimensionedField< scalar, volMesh > &
	)

Construct as copy setting internal field reference.

◆ alphaContactAngleFvPatchScalarField() [10/17]

alphaContactAngleFvPatchScalarField	(	const fvPatch &	,
		const DimensionedField< scalar, volMesh > &
	)

Construct from patch and internal field.

◆ alphaContactAngleFvPatchScalarField() [11/17]

alphaContactAngleFvPatchScalarField	(	const fvPatch &	,
		const DimensionedField< scalar, volMesh > &	,
		const dictionary &
	)

Construct from patch, internal field and dictionary.

◆ alphaContactAngleFvPatchScalarField() [12/17]

alphaContactAngleFvPatchScalarField	(	const alphaContactAngleFvPatchScalarField &	,
		const fvPatch &	,
		const DimensionedField< scalar, volMesh > &	,
		const fvPatchFieldMapper &
	)

Construct by mapping given alphaContactAngleFvPatchScalarField.

onto a new patch

◆ alphaContactAngleFvPatchScalarField() [13/17]

alphaContactAngleFvPatchScalarField	(	const alphaContactAngleFvPatchScalarField &	,
		const DimensionedField< scalar, volMesh > &
	)

Construct as copy setting internal field reference.

◆ alphaContactAngleFvPatchScalarField() [14/17]

alphaContactAngleFvPatchScalarField	(	const fvPatch &	,
		const DimensionedField< scalar, volMesh > &
	)

Construct from patch and internal field.

◆ alphaContactAngleFvPatchScalarField() [15/17]

alphaContactAngleFvPatchScalarField	(	const fvPatch &	,
		const DimensionedField< scalar, volMesh > &	,
		const dictionary &
	)

Construct from patch, internal field and dictionary.

◆ alphaContactAngleFvPatchScalarField() [16/17]

alphaContactAngleFvPatchScalarField	(	const alphaContactAngleFvPatchScalarField &	,
		const fvPatch &	,
		const DimensionedField< scalar, volMesh > &	,
		const fvPatchFieldMapper &
	)

Construct by mapping given alphaContactAngleFvPatchScalarField.

onto a new patch

◆ alphaContactAngleFvPatchScalarField() [17/17]

alphaContactAngleFvPatchScalarField	(	const alphaContactAngleFvPatchScalarField &	,
		const DimensionedField< scalar, volMesh > &
	)

Construct as copy setting internal field reference.

Member Function Documentation

◆ TypeName() [1/4]

TypeName ( "alphaContactAngle" )

Runtime type information.

◆ theta()

virtual tmp<scalarField> theta	(	const fvPatchVectorField &	Up,
		const fvsPatchVectorField &	nHat
	)		const

pure virtual

Return the contact angle.

Implemented in dynamicAlphaContactAngleFvPatchScalarField, temperatureDependentAlphaContactAngleFvPatchScalarField, constantAlphaContactAngleFvPatchScalarField, and timeVaryingAlphaContactAngleFvPatchScalarField.

◆ evaluate()

void evaluate ( const Pstream::commsTypes commsType = Pstream::commsTypes::blocking )

virtual

Evaluate the patch field.

Definition at line 133 of file alphaContactAngleFvPatchScalarField.C.

References Foam::max(), Foam::min(), Field< scalar >::operator=(), and alphaContactAngleFvPatchScalarField::write().

Referenced by alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write() [1/4]

void write ( Ostream & os ) const

virtual

Write.

Reimplemented in dynamicAlphaContactAngleFvPatchScalarField, temperatureDependentAlphaContactAngleFvPatchScalarField, constantAlphaContactAngleFvPatchScalarField, and timeVaryingAlphaContactAngleFvPatchScalarField.

Definition at line 164 of file alphaContactAngleFvPatchScalarField.C.

References Foam::vtkWriteOps::write(), and Foam::writeEntry().

Referenced by alphaContactAngleFvPatchScalarField::evaluate(), alphaContactAngleFvPatchScalarField::thetaProps(), and dynamicAlphaContactAngleFvPatchScalarField::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName() [2/4]

TypeName ( "alphaContactAngle" )

Runtime type information.

◆ clone() [1/6]

virtual tmp<fvPatchScalarField> clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented in dynamicAlphaContactAngleFvPatchScalarField, temperatureDependentAlphaContactAngleFvPatchScalarField, constantAlphaContactAngleFvPatchScalarField, and timeVaryingAlphaContactAngleFvPatchScalarField.

Definition at line 165 of file alphaContactAngleFvPatchScalarField.H.

References alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField().

Referenced by alphaContactAngleFvPatchScalarField::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clone() [2/6]

virtual tmp<fvPatchScalarField> clone ( const DimensionedField< scalar, volMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented in dynamicAlphaContactAngleFvPatchScalarField, temperatureDependentAlphaContactAngleFvPatchScalarField, constantAlphaContactAngleFvPatchScalarField, and timeVaryingAlphaContactAngleFvPatchScalarField.

Definition at line 182 of file alphaContactAngleFvPatchScalarField.H.

References alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField().

Here is the call graph for this function:

◆ thetaProps() [1/3]

const thetaPropsTable& thetaProps ( ) const

inline

Return the contact angle properties.

Definition at line 196 of file alphaContactAngleFvPatchScalarField.H.

References alphaContactAngleFvPatchScalarField::write().

Here is the call graph for this function:

◆ write() [2/4]

virtual void write ( Ostream & ) const

virtual

Write.

Reimplemented in dynamicAlphaContactAngleFvPatchScalarField, temperatureDependentAlphaContactAngleFvPatchScalarField, constantAlphaContactAngleFvPatchScalarField, and timeVaryingAlphaContactAngleFvPatchScalarField.

◆ TypeName() [3/4]

TypeName ( "alphaContactAngle" )

Runtime type information.

◆ clone() [3/6]

virtual tmp<fvPatchScalarField> clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented in dynamicAlphaContactAngleFvPatchScalarField, temperatureDependentAlphaContactAngleFvPatchScalarField, constantAlphaContactAngleFvPatchScalarField, and timeVaryingAlphaContactAngleFvPatchScalarField.

Definition at line 165 of file alphaContactAngleFvPatchScalarField.H.

References alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField(), and alphaContactAngleFvPatchScalarField::clone().

Here is the call graph for this function:

◆ clone() [4/6]

virtual tmp<fvPatchScalarField> clone ( const DimensionedField< scalar, volMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented in dynamicAlphaContactAngleFvPatchScalarField, temperatureDependentAlphaContactAngleFvPatchScalarField, constantAlphaContactAngleFvPatchScalarField, and timeVaryingAlphaContactAngleFvPatchScalarField.

Definition at line 182 of file alphaContactAngleFvPatchScalarField.H.

References alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField().

Here is the call graph for this function:

◆ thetaProps() [2/3]

const thetaPropsTable& thetaProps ( ) const

inline

Return the contact angle properties.

Definition at line 196 of file alphaContactAngleFvPatchScalarField.H.

References alphaContactAngleFvPatchScalarField::write().

Here is the call graph for this function:

◆ write() [3/4]

virtual void write ( Ostream & ) const

virtual

Write.

Reimplemented in dynamicAlphaContactAngleFvPatchScalarField, temperatureDependentAlphaContactAngleFvPatchScalarField, constantAlphaContactAngleFvPatchScalarField, and timeVaryingAlphaContactAngleFvPatchScalarField.

◆ TypeName() [4/4]

TypeName ( "alphaContactAngle" )

Runtime type information.

◆ clone() [5/6]

virtual tmp<fvPatchScalarField> clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented in dynamicAlphaContactAngleFvPatchScalarField, temperatureDependentAlphaContactAngleFvPatchScalarField, constantAlphaContactAngleFvPatchScalarField, and timeVaryingAlphaContactAngleFvPatchScalarField.

Definition at line 165 of file alphaContactAngleFvPatchScalarField.H.

References alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField(), and alphaContactAngleFvPatchScalarField::clone().

Here is the call graph for this function:

◆ clone() [6/6]

virtual tmp<fvPatchScalarField> clone ( const DimensionedField< scalar, volMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented in dynamicAlphaContactAngleFvPatchScalarField, temperatureDependentAlphaContactAngleFvPatchScalarField, constantAlphaContactAngleFvPatchScalarField, and timeVaryingAlphaContactAngleFvPatchScalarField.

Definition at line 182 of file alphaContactAngleFvPatchScalarField.H.

References alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField().

Here is the call graph for this function:

◆ thetaProps() [3/3]

const thetaPropsTable& thetaProps ( ) const

inline

Return the contact angle properties.

Definition at line 196 of file alphaContactAngleFvPatchScalarField.H.

References alphaContactAngleFvPatchScalarField::write().

Here is the call graph for this function:

◆ write() [4/4]

virtual void write ( Ostream & ) const

virtual

Write.

Reimplemented in dynamicAlphaContactAngleFvPatchScalarField, temperatureDependentAlphaContactAngleFvPatchScalarField, constantAlphaContactAngleFvPatchScalarField, and timeVaryingAlphaContactAngleFvPatchScalarField.

Member Data Documentation

◆ limitControlNames_

const Foam::NamedEnum< Foam::alphaContactAngleFvPatchScalarField::limitControls, 4 > limitControlNames_

static

Definition at line 91 of file alphaContactAngleFvPatchScalarField.H.

Referenced by NamedEnum< compressibleField, 8 >::names().

◆ limit_

limitControls limit_

Definition at line 92 of file alphaContactAngleFvPatchScalarField.H.

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

src/twoPhaseModels/twoPhaseProperties/alphaContactAngle/alphaContactAngle/alphaContactAngleFvPatchScalarField.H
src/twoPhaseModels/twoPhaseProperties/alphaContactAngle/alphaContactAngle/alphaContactAngleFvPatchScalarField.C

Classes

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ thetaPropsTable [1/3]

◆ thetaPropsTable [2/3]

◆ thetaPropsTable [3/3]

Member Enumeration Documentation

◆ limitControls

Constructor & Destructor Documentation

◆ alphaContactAngleFvPatchScalarField() [1/17]

◆ alphaContactAngleFvPatchScalarField() [2/17]

◆ alphaContactAngleFvPatchScalarField() [3/17]

◆ alphaContactAngleFvPatchScalarField() [4/17]

◆ alphaContactAngleFvPatchScalarField() [5/17]

◆ alphaContactAngleFvPatchScalarField() [6/17]

◆ alphaContactAngleFvPatchScalarField() [7/17]

◆ alphaContactAngleFvPatchScalarField() [8/17]

◆ alphaContactAngleFvPatchScalarField() [9/17]

◆ alphaContactAngleFvPatchScalarField() [10/17]

◆ alphaContactAngleFvPatchScalarField() [11/17]

◆ alphaContactAngleFvPatchScalarField() [12/17]

◆ alphaContactAngleFvPatchScalarField() [13/17]

◆ alphaContactAngleFvPatchScalarField() [14/17]

◆ alphaContactAngleFvPatchScalarField() [15/17]

◆ alphaContactAngleFvPatchScalarField() [16/17]

◆ alphaContactAngleFvPatchScalarField() [17/17]

Member Function Documentation

◆ TypeName() [1/4]

◆ theta()

◆ evaluate()

◆ write() [1/4]

◆ TypeName() [2/4]

◆ clone() [1/6]

◆ clone() [2/6]

◆ thetaProps() [1/3]

◆ write() [2/4]

◆ TypeName() [3/4]

◆ clone() [3/6]

◆ clone() [4/6]

◆ thetaProps() [2/3]

◆ write() [3/4]

◆ TypeName() [4/4]

◆ clone() [5/6]

◆ clone() [6/6]

◆ thetaProps() [3/3]

◆ write() [4/4]

Member Data Documentation

◆ limitControlNames_

◆ limit_