alphaContactAngleFvPatchScalarField::contactAngleProperties Class Reference

Public Member Functions

 contactAngleProperties ()
 Construct null. More...
 
 contactAngleProperties (const scalar theta0)
 Construct non-dynamic properties from components. More...
 
 contactAngleProperties (const scalar theta0, const scalar uTheta, const scalar thetaA, const scalar thetaR)
 Construct dynamic properties from components. More...
 
 contactAngleProperties (const dictionary &dict)
 Construct from a dictionary. More...
 
scalar theta0 () const
 Return the equilibrium contact angle theta0. More...
 
bool dynamic () const
 Return if this contact angle is dynamic. More...
 
scalar uTheta () const
 Return the dynamic contact angle velocity scale. More...
 
scalar thetaA () const
 Return the limiting advancing contact angle. More...
 
scalar thetaR () const
 Return the limiting receding contact angle. More...
 
contactAngleProperties reversed () const
 Return the contact angle properties for the reverse of this. More...
 
void write (Ostream &os) const
 Write to stream. More...
 
bool operator== (const contactAngleProperties &thetaProps) const
 Check equality between two sets of contact angle properties. More...
 
bool operator!= (const contactAngleProperties &thetaProps) const
 Check inequality between two sets of contact angle properties. More...
 

Detailed Description

Definition at line 55 of file alphaContactAngleFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ contactAngleProperties() [1/4]

Construct null.

◆ contactAngleProperties() [2/4]

contactAngleProperties ( const scalar  theta0)

Construct non-dynamic properties from components.

◆ contactAngleProperties() [3/4]

contactAngleProperties ( const scalar  theta0,
const scalar  uTheta,
const scalar  thetaA,
const scalar  thetaR 
)

Construct dynamic properties from components.

◆ contactAngleProperties() [4/4]

Construct from a dictionary.

Member Function Documentation

◆ theta0()

scalar theta0 ( ) const
inline

Return the equilibrium contact angle theta0.

Definition at line 103 of file alphaContactAngleFvPatchScalarField.H.

Referenced by Foam::correctContactAngle().

Here is the caller graph for this function:

◆ dynamic()

bool dynamic ( ) const
inline

Return if this contact angle is dynamic.

Definition at line 109 of file alphaContactAngleFvPatchScalarField.H.

Referenced by Foam::correctContactAngle().

Here is the caller graph for this function:

◆ uTheta()

scalar uTheta ( ) const
inline

Return the dynamic contact angle velocity scale.

Definition at line 115 of file alphaContactAngleFvPatchScalarField.H.

Referenced by Foam::correctContactAngle().

Here is the caller graph for this function:

◆ thetaA()

scalar thetaA ( ) const
inline

Return the limiting advancing contact angle.

Definition at line 121 of file alphaContactAngleFvPatchScalarField.H.

Referenced by Foam::correctContactAngle().

Here is the caller graph for this function:

◆ thetaR()

scalar thetaR ( ) const
inline

Return the limiting receding contact angle.

Definition at line 127 of file alphaContactAngleFvPatchScalarField.H.

Referenced by Foam::correctContactAngle().

Here is the caller graph for this function:

◆ reversed()

contactAngleProperties reversed ( ) const

Return the contact angle properties for the reverse of this.

interface (e.g., convert air_water to water_air).

◆ write()

void write ( Ostream os) const

Write to stream.

◆ operator==()

bool operator== ( const contactAngleProperties thetaProps) const

Check equality between two sets of contact angle properties.

◆ operator!=()

bool operator!= ( const contactAngleProperties thetaProps) const

Check inequality between two sets of contact angle properties.


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