gravitational Class Reference

Gravitational acceleration based contact angle model. More...

Inheritance diagram for gravitational:
Collaboration diagram for gravitational:

Public Member Functions

 TypeName ("gravitational")
 Runtime type information. More...
 
 gravitational (const dictionary &dict)
 Construct from dictionary. More...
 
virtual autoPtr< contactAngleModelclone () const
 Construct and return a clone. More...
 
virtual ~gravitational ()
 Destructor. More...
 
virtual tmp< scalarFieldcosTheta (const fvPatchVectorField &Up, const vectorField &nHat) const
 Cosine of the contact angle. More...
 
virtual void write (Ostream &os) const
 Write data in dictionary format. More...
 
- Public Member Functions inherited from contactAngleModel
 TypeName ("contactAngleModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, contactAngleModel, dictionary,(const dictionary &dict),(dict))
 
 contactAngleModel ()
 
virtual ~contactAngleModel ()
 Destructor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from contactAngleModel
static autoPtr< contactAngleModelNew (const dictionary &dict)
 
- Static Protected Member Functions inherited from contactAngleModel
static const dictionarycontactAngleDict (const dictionary &dict)
 

Detailed Description

Gravitational acceleration based contact angle model.

Usage:

Property Description Required Default value
theta0 Equilibrium contact angle yes
gTheta Gravitational acceleration scale yes
thetaAdv Limiting advancing contact angle yes
thetaRec Limiting receding contact angle yes

Example:

    contactAngle
    {
        type           gravitational;
        gTheta         0.1;
        theta0         70;
        thetaAdv       100;
        thetaRec       50;
    }
See also
Foam::contactAngleModel
Source files

Definition at line 100 of file gravitationalContactAngle.H.

Constructor & Destructor Documentation

◆ gravitational()

gravitational ( const dictionary dict)

Construct from dictionary.

Definition at line 44 of file gravitationalContactAngle.C.

Referenced by gravitational::clone().

Here is the caller graph for this function:

◆ ~gravitational()

~gravitational ( )
virtual

Destructor.

Definition at line 55 of file gravitationalContactAngle.C.

Member Function Documentation

◆ TypeName()

TypeName ( "gravitational"  )

Runtime type information.

◆ clone()

virtual autoPtr<contactAngleModel> clone ( ) const
inlinevirtual

Construct and return a clone.

Implements contactAngleModel.

Definition at line 131 of file gravitationalContactAngle.H.

References gravitational::gravitational().

Here is the call graph for this function:

◆ cosTheta()

Foam::tmp< Foam::scalarField > cosTheta ( const fvPatchVectorField Up,
const vectorField nHat 
) const
virtual

Cosine of the contact angle.

Implements contactAngleModel.

Definition at line 62 of file gravitationalContactAngle.C.

References Foam::cos(), fvPatchField< Type >::db(), objectRegistry::lookupObject(), Foam::max(), Foam::min(), Foam::tanh(), and UniformDimensionedField< Type >::value().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write data in dictionary format.

Implements contactAngleModel.

Definition at line 82 of file gravitationalContactAngle.C.

References Foam::dimAcceleration, Foam::unitDegrees, and Foam::writeEntry().

Here is the call graph for this function:

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