Public Member Functions | Static Public Member Functions | List of all members
force Class Referenceabstract

Base class for film (stress-based) force models. More...

Inheritance diagram for force:
[legend]
Collaboration diagram for force:
[legend]

Public Member Functions

 TypeName ("force")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, force, dictionary,(liquidFilmBase &film, const dictionary &dict),(film, dict))
 
 force (liquidFilmBase &film)
 Construct null. More...
 
 force (const word &modelType, liquidFilmBase &film, const dictionary &dict)
 Construct from type name, dictionary and surface film model. More...
 
virtual ~force ()
 Destructor. More...
 
virtual tmp< faVectorMatrix > correct (areaVectorField &U)=0
 Correct. More...
 
- Public Member Functions inherited from filmSubModelBase
 filmSubModelBase (liquidFilmBase &film)
 Construct null. More...
 
 filmSubModelBase (liquidFilmBase &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, liquidFilmBase &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 liquidFilmBase & film () const
 Return const access to the film surface film model. More...
 
liquidFilmBase & film ()
 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 word & modelName () const
 Return const access to the name of the sub-model. More...
 
const dictionary & dict () const
 Return const access to the cloud dictionary. More...
 
const word & baseName () const
 Return const access to the base name of the sub-model. More...
 
const word & modelType () const
 Return const access to the sub-model type. More...
 
const dictionary & coeffDict () const
 Return const access to the coefficients dictionary. More...
 
const dictionary & properties () 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...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. More...
 
virtual fileName localPath () const
 Output directory. More...
 
template<class Type >
Type getBaseProperty (const word &entryName, const Type &defaultValue=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...
 
bool getModelDict (const word &entryName, dictionary &dict) const
 Retrieve dictionary, return true if set. More...
 
template<class Type >
bool 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=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...
 

Static Public Member Functions

static autoPtr< force > New (liquidFilmBase &film, const dictionary &dict, const word &modelType)
 Return a reference to the selected force model. More...
 

Additional Inherited Members

- Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line. More...
 
- Protected Attributes inherited from filmSubModelBase
liquidFilmBase & filmModel_
 Reference to the film surface film model. More...
 
- Protected Attributes inherited from subModelBase
const word modelName_
 Name of the sub-model. More...
 
dictionary & properties_
 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 (stress-based) force models.

Source files

Definition at line 56 of file force.H.

Constructor & Destructor Documentation

◆ force() [1/2]

force ( liquidFilmBase &  film)

Construct null.

Definition at line 46 of file force.C.

◆ force() [2/2]

force ( const word &  modelType,
liquidFilmBase &  film,
const dictionary &  dict 
)

Construct from type name, dictionary and surface film model.

Definition at line 52 of file force.C.

◆ ~force()

~force ( )
virtual

Destructor.

Definition at line 65 of file force.C.

Member Function Documentation

◆ TypeName()

TypeName ( "force"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
force  ,
dictionary  ,
(liquidFilmBase &film, const dictionary &dict)  ,
(film, dict)   
)

◆ New()

autoPtr< force > New ( liquidFilmBase &  film,
const dictionary &  dict,
const word &  modelType 
)
static

Return a reference to the selected force model.

Definition at line 41 of file forceNew.C.

References subModelBase::dict(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, and subModelBase::modelType().

Here is the call graph for this function:

◆ correct()

virtual tmp< faVectorMatrix > correct ( areaVectorField &  U)
pure virtual

Correct.

Implemented in contactAngleForce.

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