Public Member Functions | Protected Member Functions | List of all members
contactAngleForce Class Referenceabstract

Base-class for film contact angle force models. More...

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

Public Member Functions

 TypeName ("contactAngle")
 Runtime type information. More...
 
 contactAngleForce (const word &typeName, surfaceFilmRegionModel &film, const dictionary &dict)
 Construct from surface film model. More...
 
virtual ~contactAngleForce ()
 Destructor. More...
 
virtual tmp< fvVectorMatrixcorrect (volVectorField &U)
 Correct. More...
 
- Public Member Functions inherited from force
 TypeName ("force")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, force, dictionary,(surfaceFilmRegionModel &film, const dictionary &dict),(film, dict))
 
 force (surfaceFilmRegionModel &film)
 Construct null. More...
 
 force (const word &modelType, surfaceFilmRegionModel &film, const dictionary &dict)
 Construct from type name, dictionary and surface film model. More...
 
virtual ~force ()
 Destructor. More...
 
- Public Member Functions inherited from filmSubModelBase
 filmSubModelBase (surfaceFilmRegionModel &film)
 Construct null. More...
 
 filmSubModelBase (surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from film film without name. More...
 
 filmSubModelBase (const word &modelName, surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType)
 Construct from film film with name. More...
 
virtual ~filmSubModelBase ()
 Destructor. More...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. More...
 
const surfaceFilmRegionModelfilm () const
 Return const access to the film surface film model. More...
 
surfaceFilmRegionModelfilm ()
 Return the reference to the film surface film model. More...
 
template<class FilmType >
const FilmType & filmType () const
 
- Public Member Functions inherited from subModelBase
 subModelBase (dictionary &properties)
 Construct null. More...
 
 subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from components without name. More...
 
 subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
 Construct from components with name. More...
 
 subModelBase (const subModelBase &smb)
 Construct as copy. More...
 
virtual ~subModelBase ()
 Destructor. More...
 
const wordmodelName () const
 Return const access to the name of the sub-model. More...
 
const dictionarydict () const
 Return const access to the cloud dictionary. More...
 
const wordbaseName () const
 Return const access to the base name of the sub-model. More...
 
const wordmodelType () const
 Return const access to the sub-model type. More...
 
const dictionarycoeffDict () const
 Return const access to the coefficients dictionary. More...
 
const dictionaryproperties () const
 Return const access to the properties dictionary. More...
 
virtual bool defaultCoeffs (const bool printMsg) const
 Returns true if defaultCoeffs is true and outputs on printMsg. More...
 
virtual bool active () const
 Return the model 'active' status - default active = true. More...
 
virtual void cacheFields (const bool store)
 Cache dependent sub-model fields. More...
 
template<class Type >
Type getBaseProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
 Retrieve generic property from the base model. More...
 
template<class Type >
void getBaseProperty (const word &entryName, Type &value) const
 Retrieve generic property from the base model. More...
 
template<class Type >
void setBaseProperty (const word &entryName, const Type &value)
 Add generic property to the base model. More...
 
template<class Type >
void getModelProperty (const word &entryName, Type &value) const
 Retrieve generic property from the sub-model. More...
 
template<class Type >
Type getModelProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
 Retrieve generic property from the sub-model. More...
 
template<class Type >
void setModelProperty (const word &entryName, const Type &value)
 Add generic property to the sub-model. More...
 
virtual void write (Ostream &os) const
 Write. More...
 

Protected Member Functions

virtual tmp< volScalarFieldtheta () const =0
 Return the contact angle field. More...
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from force
static autoPtr< forceNew (surfaceFilmRegionModel &film, const dictionary &dict, const word &modelType)
 Return a reference to the selected force model. More...
 
- Protected Attributes inherited from filmSubModelBase
surfaceFilmRegionModelfilmModel_
 Reference to the film surface film model. More...
 
- Protected Attributes inherited from subModelBase
const word modelName_
 Name of the sub-model. More...
 
dictionaryproperties_
 Reference to properties dictionary e.g. for restart. More...
 
const dictionary dict_
 Copy of dictionary used during construction. More...
 
const word baseName_
 Name of the sub-model base class. More...
 
const word modelType_
 Type of the sub-model. More...
 
const dictionary coeffDict_
 Coefficients dictionary. More...
 

Detailed Description

Base-class for film contact angle force models.

The effect of the contact angle force can be ignored over a specified distance from patches.

Source files

Definition at line 55 of file contactAngleForce.H.

Constructor & Destructor Documentation

◆ contactAngleForce()

contactAngleForce ( const word typeName,
surfaceFilmRegionModel film,
const dictionary dict 
)

Construct from surface film model.

Definition at line 96 of file contactAngleForce.C.

◆ ~contactAngleForce()

~contactAngleForce ( )
virtual

Destructor.

Definition at line 124 of file contactAngleForce.C.

Member Function Documentation

◆ theta()

virtual tmp<volScalarField> theta ( ) const
protectedpure virtual

Return the contact angle field.

Implemented in perturbedTemperatureDependentContactAngleForce, temperatureDependentContactAngleForce, and distributionContactAngleForce.

Referenced by contactAngleForce::correct().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "contactAngle"  )

Runtime type information.

◆ correct()

tmp< fvVectorMatrix > correct ( volVectorField U)
virtual

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