Classes | Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
alphaContactAngleFvPatchScalarField Class Referenceabstract

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

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

Classes

class  interfaceThetaProps
 

Public Types

enum  limitControls { lcNone, lcGradient, lcZeroGradient, lcAlpha }
 Alpha limit options. More...
 
typedef HashTable< interfaceThetaProps, multiphaseMixtureThermo::interfacePair, multiphaseMixtureThermo::interfacePair::hashthetaPropsTable
 
typedef HashTable< interfaceThetaProps, multiphaseSystem::interfacePair, multiphaseSystem::interfacePair::symmHashthetaPropsTable
 
typedef HashTable< interfaceThetaProps, multiphaseMixture::interfacePair, multiphaseMixture::interfacePair::hashthetaPropsTable
 
typedef HashTable< interfaceThetaProps, phasePairKey, phasePairKey::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...
 
 alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &)
 Construct as copy. More...
 
 alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< scalarFieldtheta (const fvPatchVectorField &Up, const fvsPatchVectorField &nHat) const =0
 Return the contact angle. More...
 
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::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< 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...
 
 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...
 

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 conjuction with multiphaseSystem.

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

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

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

limit none; // Calculate the gradient from the contact-angle without limiter

limit gradient; // Limit the wall-gradient such that alpha1 remains bounded on the wall

limit alpha; // Bound the calculated alpha1 on the wall

limit zeroGradient; // Set the gradient of alpha1 to 0 on the wall i.e. reproduce previous behaviour

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.

myPatch
{
    type            alphaContactAngle;
}

If "limit zeroGradient;" is used the pressure BCs can be left as before.

Source files

Source files

Source files

Source files

Source files

Definition at line 81 of file alphaContactAngleFvPatchScalarField.H.

Member Typedef Documentation

Definition at line 121 of file alphaContactAngleFvPatchScalarField.H.

Definition at line 121 of file alphaContactAngleFvPatchScalarField.H.

Definition at line 121 of file alphaContactAngleFvPatchScalarField.H.

Definition at line 121 of file alphaContactAngleFvPatchScalarField.H.

Member Enumeration Documentation

Alpha limit options.

Enumerator
lcNone 
lcGradient 
lcZeroGradient 
lcAlpha 

Definition at line 92 of file alphaContactAngleFvPatchScalarField.H.

Constructor & Destructor Documentation

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< Enum, nEnum >::names().

Here is the caller graph for this function:

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 ( 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:

Construct as copy.

Definition at line 110 of file alphaContactAngleFvPatchScalarField.C.

References alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField().

Here is the call graph for this function:

Construct as copy setting internal field reference.

Definition at line 120 of file alphaContactAngleFvPatchScalarField.C.

References alphaContactAngleFvPatchScalarField::evaluate().

Here is the call graph for this function:

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.

Construct by mapping given alphaContactAngleFvPatchScalarField.

onto a new patch

Construct as copy setting internal field reference.

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.

Construct by mapping given alphaContactAngleFvPatchScalarField.

onto a new patch

Construct as copy setting internal field reference.

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.

Construct by mapping given alphaContactAngleFvPatchScalarField.

onto a new patch

Construct as copy setting internal field reference.

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.

Construct by mapping given alphaContactAngleFvPatchScalarField.

onto a new patch

Construct as copy setting internal field reference.

Member Function Documentation

TypeName ( "alphaContactAngle"  )

Runtime type information.

virtual tmp<scalarField> theta ( const fvPatchVectorField Up,
const fvsPatchVectorField nHat 
) const
pure virtual
void evaluate ( const Pstream::commsTypes  commsType = Pstream::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:

void write ( Ostream os) const
virtual
TypeName ( "alphaContactAngle"  )

Runtime type information.

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual
virtual tmp<fvPatchScalarField> clone ( const DimensionedField< scalar, volMesh > &  iF) const
inlinevirtual
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:

virtual void write ( Ostream ) const
virtual
TypeName ( "alphaContactAngle"  )

Runtime type information.

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual
virtual tmp<fvPatchScalarField> clone ( const DimensionedField< scalar, volMesh > &  iF) const
inlinevirtual
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:

virtual void write ( Ostream ) const
virtual
TypeName ( "alphaContactAngle"  )

Runtime type information.

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual
virtual tmp<fvPatchScalarField> clone ( const DimensionedField< scalar, volMesh > &  iF) const
inlinevirtual
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:

virtual void write ( Ostream ) const
virtual
TypeName ( "alphaContactAngle"  )

Runtime type information.

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual
virtual tmp<fvPatchScalarField> clone ( const DimensionedField< scalar, volMesh > &  iF) const
inlinevirtual
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:

virtual void write ( Ostream ) const
virtual

Member Data Documentation

limitControls limit_

Definition at line 101 of file alphaContactAngleFvPatchScalarField.H.


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