constantAlphaContactAngleFvPatchScalarField Class Reference

A constant alphaContactAngle scalar boundary condition. More...

Inheritance diagram for constantAlphaContactAngleFvPatchScalarField:
Collaboration diagram for constantAlphaContactAngleFvPatchScalarField:

Public Member Functions

 TypeName ("constantAlphaContactAngle")
 Runtime type information. More...
 
 constantAlphaContactAngleFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 constantAlphaContactAngleFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 constantAlphaContactAngleFvPatchScalarField (const constantAlphaContactAngleFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given. More...
 
 constantAlphaContactAngleFvPatchScalarField (const constantAlphaContactAngleFvPatchScalarField &)=delete
 Disallow copy without setting internal field reference. More...
 
 constantAlphaContactAngleFvPatchScalarField (const constantAlphaContactAngleFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual tmp< fvPatchScalarFieldclone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual tmp< scalarFieldtheta (const fvPatchVectorField &Up, const fvsPatchVectorField &nHat) const
 Return the equilibrium contact-angle. More...
 
virtual void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from alphaContactAngleFvPatchScalarField
 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 &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
const HashTable< contactAngleProperties > & thetaProps () const
 Return the contact angle properties. 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...
 
 alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &)=delete
 Disallow copy without setting internal field reference. More...
 
 alphaContactAngleFvPatchScalarField (const alphaContactAngleFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
 Evaluate the patch field. More...
 

Additional Inherited Members

- Public Types inherited from alphaContactAngleFvPatchScalarField
enum  limitControls { lcNone, lcGradient, lcZeroGradient, lcAlpha }
 Alpha limit options. More...
 
- Public Attributes inherited from alphaContactAngleFvPatchScalarField
limitControls limit_
 
- Static Public Attributes inherited from alphaContactAngleFvPatchScalarField
static const NamedEnum< limitControls, 4 > limitControlNames_
 

Detailed Description

Constructor & Destructor Documentation

◆ constantAlphaContactAngleFvPatchScalarField() [1/5]

Construct from patch and internal field.

Definition at line 35 of file constantAlphaContactAngleFvPatchScalarField.C.

Referenced by constantAlphaContactAngleFvPatchScalarField::clone(), and constantAlphaContactAngleFvPatchScalarField::constantAlphaContactAngleFvPatchScalarField().

Here is the caller graph for this function:

◆ constantAlphaContactAngleFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 47 of file constantAlphaContactAngleFvPatchScalarField.C.

References constantAlphaContactAngleFvPatchScalarField::constantAlphaContactAngleFvPatchScalarField(), and Foam::evaluate().

Here is the call graph for this function:

◆ constantAlphaContactAngleFvPatchScalarField() [3/5]

Construct by mapping given.

constantAlphaContactAngleFvPatchScalarField onto a new patch

Definition at line 62 of file constantAlphaContactAngleFvPatchScalarField.C.

References constantAlphaContactAngleFvPatchScalarField::constantAlphaContactAngleFvPatchScalarField().

Here is the call graph for this function:

◆ constantAlphaContactAngleFvPatchScalarField() [4/5]

Disallow copy without setting internal field reference.

◆ constantAlphaContactAngleFvPatchScalarField() [5/5]

Copy constructor setting internal field reference.

Definition at line 76 of file constantAlphaContactAngleFvPatchScalarField.C.

References constantAlphaContactAngleFvPatchScalarField::theta().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "constantAlphaContactAngle"  )

Runtime type information.

◆ clone()

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

◆ theta()

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

Return the equilibrium contact-angle.

Implements alphaContactAngleFvPatchScalarField.

Definition at line 90 of file constantAlphaContactAngleFvPatchScalarField.C.

References scalarField(), and constantAlphaContactAngleFvPatchScalarField::write().

Referenced by constantAlphaContactAngleFvPatchScalarField::clone(), and constantAlphaContactAngleFvPatchScalarField::constantAlphaContactAngleFvPatchScalarField().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from alphaContactAngleFvPatchScalarField.

Definition at line 100 of file constantAlphaContactAngleFvPatchScalarField.C.

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

Referenced by constantAlphaContactAngleFvPatchScalarField::clone(), and constantAlphaContactAngleFvPatchScalarField::theta().

Here is the call graph for this function:
Here is the caller graph for this function:

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