Inheritance diagram for contactAngleForce:

Collaboration diagram for contactAngleForce:

[legend]

Public Member Functions
	TypeName ("contactAngle")
	Runtime type information. More...

	contactAngleForce (surfaceFilmModel &owner, const dictionary &dict)
	Construct from surface film model. More...

virtual	~contactAngleForce ()
	Destructor. More...

virtual tmp< fvVectorMatrix >	correct (volVectorField &U)
	Correct. More...

Public Member Functions inherited from force
	TypeName ("force")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, force, dictionary,(surfaceFilmModel &owner, const dictionary &dict),(owner, dict))

	force (surfaceFilmModel &owner)
	Construct null. More...

	force (const word &modelType, surfaceFilmModel &owner, const dictionary &dict)
	Construct from type name, dictionary and surface film model. More...

virtual	~force ()
	Destructor. More...

Public Member Functions inherited from filmSubModelBase
	filmSubModelBase (surfaceFilmModel &owner)
	Construct null. More...

	filmSubModelBase (surfaceFilmModel &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from owner film wihout name. More...

	filmSubModelBase (const word &modelName, surfaceFilmModel &owner, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from owner film with name. More...

virtual	~filmSubModelBase ()
	Destructor. More...

virtual bool	outputTime () const
	Flag to indicate when to write a property. More...

const surfaceFilmModel &	owner () const
	Return const access to the owner surface film model. More...

surfaceFilmModel &	owner ()
	Return the reference to the owner 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 dependant 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...

Private Member Functions
void	initialise ()
	Initialise. More...

	contactAngleForce (const contactAngleForce &)
	Disallow default bitwise copy construct. More...

void	operator= (const contactAngleForce &)
	Disallow default bitwise assignment. More...

Private Attributes
scalar	Ccf_
	Coefficient applied to the contact angle force. More...

cachedRandom	rndGen_
	Random number generator. More...

const autoPtr< distributionModels::distributionModel >	distribution_
	Parcel size PDF model. More...

volScalarField	mask_
	Mask over which force is applied. More...

Additional Inherited Members
Static Public Member Functions inherited from force
static autoPtr< force >	New (surfaceFilmModel &owner, const dictionary &dict, const word &modelType)
	Return a reference to the selected force model. More...

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
surfaceFilmModel &	owner_
	Reference to the owner 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

Definition at line 57 of file contactAngleForce.H.

Constructor & Destructor Documentation

◆ contactAngleForce() [1/2]

contactAngleForce ( const contactAngleForce & )

private

Disallow default bitwise copy construct.

◆ contactAngleForce() [2/2]

contactAngleForce	(	surfaceFilmModel &	owner,
		const dictionary &	dict
	)

Construct from surface film model.

Definition at line 95 of file contactAngleForce.C.

◆ ~contactAngleForce()

~contactAngleForce ( )

virtual

Destructor.

Definition at line 131 of file contactAngleForce.C.

Member Function Documentation

◆ initialise()

void initialise ( )

private

Initialise.

Definition at line 49 of file contactAngleForce.C.

References polyMesh::boundaryMesh(), subModelBase::coeffDict_, meshWave::correct(), Foam::dimLength, Foam::endl(), forAllConstIter(), Foam::Info, dictionary::lookup(), contactAngleForce::mask_, IOobject::name(), IOobject::NO_READ, IOobject::NO_WRITE, filmSubModelBase::owner_, polyBoundaryMesh::patchSet(), Foam::pos(), Foam::readScalar(), regionModel::regionMesh(), List::size(), fvMesh::time(), Time::timeName(), and y.

Here is the call graph for this function:

◆ operator=()

void operator= ( const contactAngleForce & )

private

Disallow default bitwise assignment.

◆ TypeName()

TypeName ( "contactAngle" )

Runtime type information.

◆ correct()

tmp< fvVectorMatrix > correct ( volVectorField & U )

virtual

Correct.

Implements force.

Definition at line 137 of file contactAngleForce.C.

References Foam::constant::atomic::alpha, surfaceFilmModel::alpha(), GeometricField::boundaryField(), contactAngleForce::Ccf_, Foam::cos(), Foam::degToRad(), surfaceInterpolation::deltaCoeffs(), fvPatch::deltaCoeffs(), Foam::dimArea, Foam::dimForce, Foam::dimVolume, contactAngleForce::distribution_, fvPatch::faceCells(), forAll, Foam::fvc::grad(), Foam::mag(), singleLayerRegion::magSf(), contactAngleForce::mask_, n, fvMesh::neighbour(), IOobject::NO_READ, IOobject::NO_WRITE, TimeState::outputTime(), filmSubModelBase::owner(), fvMesh::owner(), filmSubModelBase::owner_, fvPatchField::patch(), regionModel::regionMesh(), Foam::constant::physicoChemical::sigma, surfaceFilmModel::sigma(), regionModel::time(), fvMesh::time(), Time::timeName(), U, and Vector< scalar >::zero.

Here is the call graph for this function:

Field Documentation

◆ Ccf_

scalar Ccf_

private

Coefficient applied to the contact angle force.

Definition at line 66 of file contactAngleForce.H.

Referenced by contactAngleForce::correct().

◆ rndGen_

cachedRandom rndGen_

private

Random number generator.

Definition at line 69 of file contactAngleForce.H.

◆ distribution_

const autoPtr<distributionModels::distributionModel> distribution_

private

Parcel size PDF model.

Definition at line 72 of file contactAngleForce.H.

Referenced by contactAngleForce::correct().

◆ mask_

volScalarField mask_

private

Mask over which force is applied.

Definition at line 75 of file contactAngleForce.H.

Referenced by contactAngleForce::correct(), and contactAngleForce::initialise().

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

src/regionModels/surfaceFilmModels/submodels/kinematic/force/contactAngleForce/contactAngleForce.H
src/regionModels/surfaceFilmModels/submodels/kinematic/force/contactAngleForce/contactAngleForce.C

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ contactAngleForce() [1/2]

◆ contactAngleForce() [2/2]

◆ ~contactAngleForce()

Member Function Documentation

◆ initialise()

◆ operator=()

◆ TypeName()

◆ correct()

Field Documentation

◆ Ccf_

◆ rndGen_

◆ distribution_

◆ mask_