alphaContactAngleFvPatchScalarField Class Reference

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

Inheritance diagram for alphaContactAngleFvPatchScalarField:
[legend]
Collaboration diagram for alphaContactAngleFvPatchScalarField:
[legend]

Classes

class  interfaceThetaProps
 

Public Types

typedef HashTable< interfaceThetaProps, multiphaseSystem::interfacePair, multiphaseSystem::interfacePair::symmHashthetaPropsTable
 
typedef HashTable< interfaceThetaProps, phasePairKey, phasePairKey::hashthetaPropsTable
 
typedef HashTable< interfaceThetaProps, multiphaseMixtureThermo::interfacePair, multiphaseMixtureThermo::interfacePair::hashthetaPropsTable
 
typedef HashTable< interfaceThetaProps, multiphaseMixture::interfacePair, multiphaseMixture::interfacePair::hashthetaPropsTable
 

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...
 
virtual tmp< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchScalarFieldclone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
const thetaPropsTablethetaProps () 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 &)
 
virtual tmp< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchScalarFieldclone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
const thetaPropsTablethetaProps () const noexcept
 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< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchScalarFieldclone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
const thetaPropsTablethetaProps () 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< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchScalarFieldclone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
const thetaPropsTablethetaProps () const
 Return the contact angle properties. More...
 
virtual void write (Ostream &) const
 Write. More...
 

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:

Source files

Source files

Source files

Definition at line 52 of file alphaContactAngleFvPatchScalarField.H.

Member Typedef Documentation

◆ thetaPropsTable [1/4]

◆ thetaPropsTable [2/4]

◆ thetaPropsTable [3/4]

◆ thetaPropsTable [4/4]

Constructor & Destructor Documentation

◆ alphaContactAngleFvPatchScalarField() [1/16]

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

Construct from patch and internal field.

Definition at line 78 of file alphaContactAngleFvPatchScalarField.C.

Referenced by alphaContactAngleFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ alphaContactAngleFvPatchScalarField() [2/16]

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

Construct from patch, internal field and dictionary.

Definition at line 101 of file alphaContactAngleFvPatchScalarField.C.

References Foam::stringOps::evaluate().

Here is the call graph for this function:

◆ alphaContactAngleFvPatchScalarField() [3/16]

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

Construct by mapping given alphaContactAngleFvPatchScalarField.

onto a new patch

Definition at line 88 of file alphaContactAngleFvPatchScalarField.C.

◆ alphaContactAngleFvPatchScalarField() [4/16]

Construct as copy setting internal field reference.

Definition at line 115 of file alphaContactAngleFvPatchScalarField.C.

◆ alphaContactAngleFvPatchScalarField() [5/16]

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

Construct from patch and internal field.

◆ alphaContactAngleFvPatchScalarField() [6/16]

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

Construct from patch, internal field and dictionary.

◆ alphaContactAngleFvPatchScalarField() [7/16]

Construct by mapping given alphaContactAngleFvPatchScalarField onto a new patch

◆ alphaContactAngleFvPatchScalarField() [8/16]

Construct as copy setting internal field reference.

◆ alphaContactAngleFvPatchScalarField() [9/16]

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

Construct from patch and internal field.

◆ alphaContactAngleFvPatchScalarField() [10/16]

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

Construct from patch, internal field and dictionary.

◆ alphaContactAngleFvPatchScalarField() [11/16]

Construct by mapping given alphaContactAngleFvPatchScalarField.

onto a new patch

◆ alphaContactAngleFvPatchScalarField() [12/16]

Construct as copy setting internal field reference.

◆ alphaContactAngleFvPatchScalarField() [13/16]

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

Construct from patch and internal field.

◆ alphaContactAngleFvPatchScalarField() [14/16]

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

Construct from patch, internal field and dictionary.

◆ alphaContactAngleFvPatchScalarField() [15/16]

Construct by mapping given alphaContactAngleFvPatchScalarField.

onto a new patch

◆ alphaContactAngleFvPatchScalarField() [16/16]

Construct as copy setting internal field reference.

Member Function Documentation

◆ TypeName() [1/4]

TypeName ( "alphaContactAngle"  )

Runtime type information.

◆ clone() [1/8]

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 167 of file alphaContactAngleFvPatchScalarField.H.

References alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [2/8]

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

Construct and return a clone setting internal field reference.

Definition at line 184 of file alphaContactAngleFvPatchScalarField.H.

References alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField().

Here is the call graph for this function:

◆ thetaProps() [1/4]

const thetaPropsTable& thetaProps ( ) const
inline

Return the contact angle properties.

Definition at line 198 of file alphaContactAngleFvPatchScalarField.H.

◆ write() [1/4]

void write ( Ostream os) const
virtual

Write.

Definition at line 127 of file alphaContactAngleFvPatchScalarField.C.

References os(), and fvPatchField< scalar >::write().

Here is the call graph for this function:

◆ TypeName() [2/4]

TypeName ( "alphaContactAngle"  )

Runtime type information.

◆ clone() [3/8]

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 247 of file alphaContactAngleFvPatchScalarField.H.

References alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [4/8]

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

Construct and return a clone setting internal field reference.

Definition at line 264 of file alphaContactAngleFvPatchScalarField.H.

References alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField().

Here is the call graph for this function:

◆ thetaProps() [2/4]

const thetaPropsTable& thetaProps ( ) const
inlinenoexcept

Return the contact angle properties.

Definition at line 278 of file alphaContactAngleFvPatchScalarField.H.

◆ write() [2/4]

virtual void write ( Ostream ) const
virtual

Write.

◆ TypeName() [3/4]

TypeName ( "alphaContactAngle"  )

Runtime type information.

◆ clone() [5/8]

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 167 of file alphaContactAngleFvPatchScalarField.H.

References alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [6/8]

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

Construct and return a clone setting internal field reference.

Definition at line 184 of file alphaContactAngleFvPatchScalarField.H.

References alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField().

Here is the call graph for this function:

◆ thetaProps() [3/4]

const thetaPropsTable& thetaProps ( ) const
inline

Return the contact angle properties.

Definition at line 198 of file alphaContactAngleFvPatchScalarField.H.

◆ write() [3/4]

virtual void write ( Ostream ) const
virtual

Write.

◆ TypeName() [4/4]

TypeName ( "alphaContactAngle"  )

Runtime type information.

◆ clone() [7/8]

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 167 of file alphaContactAngleFvPatchScalarField.H.

References alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [8/8]

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

Construct and return a clone setting internal field reference.

Definition at line 184 of file alphaContactAngleFvPatchScalarField.H.

References alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField().

Here is the call graph for this function:

◆ thetaProps() [4/4]

const thetaPropsTable& thetaProps ( ) const
inline

Return the contact angle properties.

Definition at line 198 of file alphaContactAngleFvPatchScalarField.H.

◆ write() [4/4]

virtual void write ( Ostream ) const
virtual

Write.


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