Abstract base-class for surface tension models which return the surface tension coefficient field. More...

Inheritance diagram for surfaceTensionModel:

[legend]

Collaboration diagram for surfaceTensionModel:

[legend]

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

	declareRunTimeSelectionTable (autoPtr, surfaceTensionModel, dictionary,(const dictionary &dict, const fvMesh &mesh),(dict, mesh))

	surfaceTensionModel (const fvMesh &mesh)

virtual	~surfaceTensionModel ()
	Destructor. More...

virtual tmp< volScalarField >	sigma () const =0
	Surface tension coefficient. More...

virtual bool	readDict (const dictionary &dict)=0
	Update surface tension coefficient from given dictionary. More...

virtual bool	writeData (Ostream &os) const =0
	Write in dictionary format. More...

	TypeName ("surfaceTensionModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, surfaceTensionModel, dictionary,(const dictionary &dict, const phasePair &pair, const bool registerObject),(dict, pair, registerObject))

	surfaceTensionModel (const dictionary &dict, const phasePair &pair, const bool registerObject)
	Construct from a dictionary and a phase pair. More...

virtual	~surfaceTensionModel ()
	Destructor. More...

virtual tmp< volScalarField >	sigma () const =0
	Surface tension. More...

virtual tmp< scalarField >	sigma (label patchi) const =0
	Surface tension for a patch. More...

bool	writeData (Ostream &os) const
	Dummy write for regIOobject. More...

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

	regIOobject (const IOobject &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

	regIOobject (const regIOobject &)
	Copy constructor. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Copy constructor, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy constructor with new name, transferring registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Copy constructor with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

virtual void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

void	store ()
	Transfer ownership of this object to its registry. More...

void	release ()
	Release ownership of this object from its registry. More...

label	eventNo () const
	Event number at last update. More...

label &	eventNo ()
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set up to date (obviously) More...

virtual void	rename (const word &newName)
	Rename. More...

virtual fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool read=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

virtual bool	read ()
	Read object. More...

virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched. Return. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	global () const
	Is object same for all processors. More...

virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
	Write using given format, version and compression. More...

virtual bool	write (const bool write=true) const
	Write using setting from DB. More...

void	operator= (const IOobject &)

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

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Construct from copy resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Construct from copy resetting name. More...

	IOobject (const IOobject &io)=default
	Copy constructor. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

virtual	~IOobject ()
	Destructor. More...

const Time &	time () const
	Return time. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

word &	headerClassName ()
	Return name of the class name read from header. More...

string &	note ()
	Return non-constant access to the optional note. More...

const string &	note () const
	Return the optional note. More...

bool &	registerObject ()
	Register object created from this IOobject with registry if true. More...

bool	registerObject () const
	Register object created from this IOobject with registry if true. More...

readOption	readOpt () const

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

word	modelName (const char *name) const
	Return the name of the object within this model. More...

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const

fileName &	instance ()

const fileName &	local () const

fileName	path () const
	Return complete path. More...

fileName	path (const word &instance, const fileName &local="") const
	Return complete path with alternative instance and local. More...

fileName	localPath () const
	Return the path relative to the case. More...

fileName	objectPath () const
	Return complete path + object name. More...

fileName	localObjectPath () const
	Return complete localPath + object name. More...

fileName	localFilePath (const word &typeName) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName) const
	Helper for filePath that searches up if in parallel. More...

bool	readHeader (Istream &)
	Read header. More...

template<class Type >
bool	typeHeaderOk (const bool checkType=true)
	Read header (uses typeFilePath to find file) and check header. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &) const
	Write header. More...

bool	writeHeader (Ostream &, const word &objectType) const
	Write header. Allow override of type. More...

bool	good () const

bool	bad () const

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &)

template<class Name >
Foam::word	groupName (Name name, const word &group)

template<class Name >
Foam::word	modelName (Name name, const word &model)

Static Public Member Functions
static autoPtr< surfaceTensionModel >	New (const dictionary &dict, const fvMesh &mesh)

static autoPtr< surfaceTensionModel >	New (const dictionary &dict, const phasePair &pair)

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class Name >
static word	groupName (Name name, const word &group)

static word	group (const word &name)
	Return group (extension part of name) More...

static word	member (const word &name)
	Return member (name without the extension) More...

template<class Name >
static word	modelName (Name name, const word &model)
	Return the name of the object within the given model. More...

template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...

template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...

Static Public Attributes
static const dimensionSet	dimSigma
	Surface tension coefficient dimensions. More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static constexpr const char *	foamFile = "FoamFile"
	Keyword for the FoamFile header sub-dictionary. More...

static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

Static Protected Member Functions
static const dictionary &	sigmaDict (const dictionary &dict)

Protected Attributes
const fvMesh &	mesh_
	Reference to mesh. More...

const phasePair &	pair_
	Phase pair. More...

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
	Enumeration defining the read options. More...

enum	writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
	Enumeration defining the write options. More...

enum	fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Enumeration defining the file checking options. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName)
	Helper: check readOpt flags and read if necessary. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &)
	Set the object state to bad. More...

Detailed Description

Abstract base-class for surface tension models which return the surface tension coefficient field.

Usage

Example of the surface tension specification:

    sigma
    {
        type                <surface tension model type>;
        <coefficient name>  <coefficient value>;
        .
        .
        .
    }

For simplicity and backward-compatibility the constant value format is also supported, e.g.

    sigma           0.07;

Source files

Definition at line 73 of file surfaceTensionModel.H.

Constructor & Destructor Documentation

◆ surfaceTensionModel() [1/2]

surfaceTensionModel ( const fvMesh & mesh )

Definition at line 43 of file surfaceTensionModel.C.

◆ ~surfaceTensionModel() [1/2]

~surfaceTensionModel ( )

virtual

Destructor.

Definition at line 62 of file surfaceTensionModel.C.

◆ surfaceTensionModel() [2/2]

surfaceTensionModel	(	const dictionary &	dict,
		const phasePair &	pair,
		const bool	registerObject
	)

Construct from a dictionary and a phase pair.

◆ ~surfaceTensionModel() [2/2]

virtual ~surfaceTensionModel ( )

virtual

Destructor.

Member Function Documentation

◆ sigmaDict()

static const dictionary& sigmaDict ( const dictionary & dict )

inlinestaticprotected

Definition at line 87 of file surfaceTensionModel.H.

References surfaceTensionModel::declareRunTimeSelectionTable(), dict, mesh, dictionary::subDict(), and surfaceTensionModel::TypeName().

Referenced by temperatureDependent::readDict().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName() [1/2]

TypeName ( "surfaceTensionModel" )

Runtime type information.

Referenced by surfaceTensionModel::sigmaDict().

Here is the caller graph for this function:

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable	(	autoPtr	,
		surfaceTensionModel	,
		dictionary	,
		(const dictionary &dict, const fvMesh &mesh)	,
		(dict, mesh)
	)

Referenced by surfaceTensionModel::sigmaDict().

Here is the caller graph for this function:

◆ New() [1/2]

Foam::autoPtr< Foam::surfaceTensionModel > New	(	const dictionary &	dict,
		const fvMesh &	mesh
	)

static

Definition at line 32 of file surfaceTensionModelNew.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, dictionary::isDict(), dictionary::lookup(), and mesh.

Here is the call graph for this function:

◆ sigma() [1/3]

virtual tmp<volScalarField> sigma ( ) const

pure virtual

Surface tension coefficient.

Implemented in temperatureDependent, liquidProperties, constant, and constantSurfaceTensionCoefficient.

◆ readDict()

virtual bool readDict ( const dictionary & dict )

pure virtual

Update surface tension coefficient from given dictionary.

Implemented in temperatureDependent, liquidProperties, and constant.

◆ writeData() [1/2]

bool writeData ( Ostream & os ) const

pure virtual

Write in dictionary format.

Implements regIOobject.

Implemented in temperatureDependent, liquidProperties, and constant.

Definition at line 68 of file surfaceTensionModel.C.

References IOstream::good().

Referenced by constant::writeData(), and temperatureDependent::writeData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName() [2/2]

TypeName ( "surfaceTensionModel" )

Runtime type information.

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable	(	autoPtr	,
		surfaceTensionModel	,
		dictionary	,
		(const dictionary &dict, const phasePair &pair, const bool registerObject)	,
		(dict, pair, registerObject)
	)

◆ New() [2/2]

static autoPtr<surfaceTensionModel> New	(	const dictionary &	dict,
		const phasePair &	pair
	)

static

◆ sigma() [2/3]

virtual tmp<volScalarField> sigma ( ) const

pure virtual

Surface tension.

Implemented in temperatureDependent, liquidProperties, constant, and constantSurfaceTensionCoefficient.

◆ sigma() [3/3]

virtual tmp<scalarField> sigma ( label patchi ) const

pure virtual

Surface tension for a patch.

Implemented in constantSurfaceTensionCoefficient.

◆ writeData() [2/2]

bool writeData ( Ostream & os ) const

virtual

Dummy write for regIOobject.

Implements regIOobject.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

Reference to mesh.

Definition at line 82 of file surfaceTensionModel.H.

◆ dimSigma

static const dimensionSet dimSigma

static

Surface tension coefficient dimensions.

Coefficient dimensions.

Definition at line 117 of file surfaceTensionModel.H.

◆ pair_

const phasePair& pair_

protected

Phase pair.

Definition at line 61 of file surfaceTensionModel.H.

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

src/twoPhaseModels/interfaceProperties/surfaceTensionModels/surfaceTensionModel/surfaceTensionModel.H
src/twoPhaseModels/interfaceProperties/surfaceTensionModels/surfaceTensionModel/surfaceTensionModel.C
src/twoPhaseModels/interfaceProperties/surfaceTensionModels/surfaceTensionModel/surfaceTensionModelNew.C

Public Member Functions

Static Public Member Functions

Static Public Attributes

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ surfaceTensionModel() [1/2]

◆ ~surfaceTensionModel() [1/2]

◆ surfaceTensionModel() [2/2]

◆ ~surfaceTensionModel() [2/2]

Member Function Documentation

◆ sigmaDict()

◆ TypeName() [1/2]

◆ declareRunTimeSelectionTable() [1/2]

◆ New() [1/2]

◆ sigma() [1/3]

◆ readDict()

◆ writeData() [1/2]

◆ TypeName() [2/2]

◆ declareRunTimeSelectionTable() [2/2]

◆ New() [2/2]

◆ sigma() [2/3]

◆ sigma() [3/3]

◆ writeData() [2/2]

Member Data Documentation

◆ mesh_

◆ dimSigma

◆ pair_