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

#include <alphaContactAngleFvPatchScalarField.H>

Inheritance diagram for alphaContactAngleFvPatchScalarField:

[legend]

Collaboration diagram for alphaContactAngleFvPatchScalarField:

[legend]

Classes
class	interfaceThetaProps

Public Types
typedef HashTable< interfaceThetaProps, multiphaseMixtureThermo::interfacePair, multiphaseMixtureThermo::interfacePair::hash >	thetaPropsTable
typedef HashTable< interfaceThetaProps, multiphaseMixture::interfacePair, multiphaseMixture::interfacePair::hash >	thetaPropsTable

Public Member Functions
	TypeName ("alphaContactAngle")
	Runtime type information.
	alphaContactAngleFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field.
	alphaContactAngleFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given alphaContactAngleFvPatchScalarField.
	alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference.
virtual tmp< fvPatchField< scalar > >	clone () const
	Return a clone.
virtual tmp< fvPatchField< scalar > >	clone (const DimensionedField< scalar, volMesh > &iF) const
	Clone with an internal field reference.
const thetaPropsTable &	thetaProps () const
	Return the contact angle properties.
virtual void	write (Ostream &) const
	Write.
	TypeName ("alphaContactAngle")
	Runtime type information.
	alphaContactAngleFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field.
	alphaContactAngleFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given alphaContactAngleFvPatchScalarField.
	alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference.
virtual tmp< fvPatchField< scalar > >	clone () const
	Return a clone.
virtual tmp< fvPatchField< scalar > >	clone (const DimensionedField< scalar, volMesh > &iF) const
	Clone with an internal field reference.
const thetaPropsTable &	thetaProps () const
	Return the contact angle properties.
virtual void	write (Ostream &) const
	Write.

Detailed Description

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

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

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

Source files

Usage

Example of the boundary condition specification:

<patch>
{
    // Mandatory entries
    type                      alphaContactAngle;
    thetaProperties
    (
        (<phase1> <phase2>) <scalar1> <scalar2> <scalar3> <scalar4>
        (<phase3> <phase2>) <scalar1> <scalar2> <scalar3> <scalar4>
        ...
    );

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: alphaContactAngle	word	yes	-
`thetaProperties`	Contact-angle properties	dict	yes	-
`<scalar1>`	Equilibrium contact angle	scalar	yes	-
`<scalar2>`	Dynamic contact angle velocity scale	scalar	yes	-
`<scalar3>`	Limiting advancing contact angle	scalar	yes	-
`<scalar4>`	Limiting receding contact angle	scalar	yes	-

The inherited entries are elaborated in:

zeroGradientFvPatchFields.H

Source files

Definition at line 48 of file alphaContactAngleFvPatchScalarField.H.

Member Typedef Documentation

◆ thetaPropsTable [1/2]

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

Definition at line 135 of file alphaContactAngleFvPatchScalarField.H.

◆ thetaPropsTable [2/2]

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

Definition at line 135 of file alphaContactAngleFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ alphaContactAngleFvPatchScalarField() [1/8]

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

Construct from patch and internal field.

Referenced by alphaContactAngleFvPatchScalarField(), and alphaContactAngleFvPatchScalarField().

Here is the caller graph for this function:

◆ alphaContactAngleFvPatchScalarField() [2/8]

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

Construct from patch, internal field and dictionary.

◆ alphaContactAngleFvPatchScalarField() [3/8]

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

Construct by mapping given alphaContactAngleFvPatchScalarField.

onto a new patch

References alphaContactAngleFvPatchScalarField().

Here is the call graph for this function:

◆ alphaContactAngleFvPatchScalarField() [4/8]

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

Construct as copy setting internal field reference.

References alphaContactAngleFvPatchScalarField().

Here is the call graph for this function:

◆ alphaContactAngleFvPatchScalarField() [5/8]

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

Construct from patch and internal field.

◆ alphaContactAngleFvPatchScalarField() [6/8]

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

Construct from patch, internal field and dictionary.

◆ alphaContactAngleFvPatchScalarField() [7/8]

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

Construct by mapping given alphaContactAngleFvPatchScalarField.

onto a new patch

References alphaContactAngleFvPatchScalarField().

Here is the call graph for this function:

◆ alphaContactAngleFvPatchScalarField() [8/8]

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

Construct as copy setting internal field reference.

References alphaContactAngleFvPatchScalarField().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName() [1/2]

TypeName ( "alphaContactAngle" )

Runtime type information.

◆ clone() [1/4]

virtual tmp< fvPatchField< scalar > > clone ( ) const

inlinevirtual

Return a clone.

Definition at line 199 of file alphaContactAngleFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ clone() [2/4]

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

inlinevirtual

Clone with an internal field reference.

Definition at line 207 of file alphaContactAngleFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ thetaProps() [1/2]

const thetaPropsTable & thetaProps ( ) const

inline

Return the contact angle properties.

Definition at line 221 of file alphaContactAngleFvPatchScalarField.H.

◆ write() [1/2]

virtual void write ( Ostream & ) const

virtual

Write.

◆ TypeName() [2/2]

TypeName ( "alphaContactAngle" )

Runtime type information.

◆ clone() [3/4]

virtual tmp< fvPatchField< scalar > > clone ( ) const

inlinevirtual

Return a clone.

Definition at line 199 of file alphaContactAngleFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ clone() [4/4]

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

inlinevirtual

Clone with an internal field reference.

Definition at line 207 of file alphaContactAngleFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ thetaProps() [2/2]

const thetaPropsTable & thetaProps ( ) const

inline

Return the contact angle properties.

Definition at line 221 of file alphaContactAngleFvPatchScalarField.H.

◆ write() [2/2]

virtual void write ( Ostream & ) const

virtual

Write.

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

applications/solvers/multiphase/compressibleMultiphaseInterFoam/multiphaseMixtureThermo/alphaContactAngle/alphaContactAngleFvPatchScalarField.H
applications/solvers/multiphase/multiphaseInterFoam/multiphaseMixture/alphaContactAngle/alphaContactAngleFvPatchScalarField.H

Classes

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ thetaPropsTable [1/2]

◆ thetaPropsTable [2/2]

Constructor & Destructor Documentation

◆ alphaContactAngleFvPatchScalarField() [1/8]

◆ alphaContactAngleFvPatchScalarField() [2/8]

◆ alphaContactAngleFvPatchScalarField() [3/8]

◆ alphaContactAngleFvPatchScalarField() [4/8]

◆ alphaContactAngleFvPatchScalarField() [5/8]

◆ alphaContactAngleFvPatchScalarField() [6/8]

◆ alphaContactAngleFvPatchScalarField() [7/8]

◆ alphaContactAngleFvPatchScalarField() [8/8]

Member Function Documentation

◆ TypeName() [1/2]

◆ clone() [1/4]

◆ clone() [2/4]

◆ thetaProps() [1/2]

◆ write() [1/2]

◆ TypeName() [2/2]

◆ clone() [3/4]

◆ clone() [4/4]

◆ thetaProps() [2/2]

◆ write() [2/2]