Temperature-dependent surface tension model. More...

Inheritance diagram for temperatureDependent:

Collaboration diagram for temperatureDependent:

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

	temperatureDependent (const dictionary &dict, const fvMesh &mesh)
	Construct from dictionary and mesh. More...

virtual	~temperatureDependent ()
	Destructor. More...

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

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

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

Public Member Functions inherited from surfaceTensionModel
	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...

	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...

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 &)
	Construct as copy. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Construct as copy, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Construct as copy with new name, transfering registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Construct as copy 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 valid=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	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool valid) const
	Write using given format, version and compression. More...

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

virtual bool	global () const
	Is object global. 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, bool globalObject=false)
	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, bool globalObject=false)
	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...

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...

bool &	globalObject ()
	Is object same for all processors. More...

bool	globalObject () const
	Is object same for all processors. 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...

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	objectPath () const
	Return complete path + 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)

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...

Static Public Member Functions inherited from surfaceTensionModel
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)

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 inherited from surfaceTensionModel
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 const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. 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...

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

Protected Attributes inherited from surfaceTensionModel
const fvMesh &	mesh_
	Reference to mesh. More...

const phasePair &	pair_
	Phase pair. More...

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

Detailed Description

Temperature-dependent surface tension model.

The surface tension is evaluated from the specified Foam::Function1 for the temperature field looked-up from the mesh database the name of which may optionally be provided.

Usage

Property	Description	Required	Default value
`T`	Temperature field name	no	T
`sigma`	Surface tension function	yes

Example of the surface tension specification:

        sigma
        {
            type                temperatureDependent;
            sigma               constant 0.07;
        }

See also: Foam::surfaceTensionModel Foam::Function1

Source files

Definition at line 91 of file temperatureDependentSurfaceTension.H.

Constructor & Destructor Documentation

◆ temperatureDependent()

temperatureDependent	(	const dictionary &	dict,
		const fvMesh &	mesh
	)

Construct from dictionary and mesh.

Definition at line 50 of file temperatureDependentSurfaceTension.C.

◆ ~temperatureDependent()

~temperatureDependent ( )

virtual

Destructor.

Definition at line 63 of file temperatureDependentSurfaceTension.C.

Member Function Documentation

◆ TypeName()

TypeName ( "temperatureDependent" )

Runtime type information.

◆ sigma()

Foam::tmp< Foam::volScalarField > sigma ( ) const

virtual

Surface tension coefficient.

Implements surfaceTensionModel.

Definition at line 70 of file temperatureDependentSurfaceTension.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), DimensionedField< Type, GeoMesh >::field(), forAll, IOobject::NO_READ, IOobject::NO_WRITE, patchi, temperatureDependent::readDict(), Foam::constant::physicoChemical::sigma, and Foam::T().

Here is the call graph for this function:

◆ readDict()

bool readDict ( const dictionary & dict )

virtual

Update surface tension coefficient from given dictionary.

Implements surfaceTensionModel.

Definition at line 108 of file temperatureDependentSurfaceTension.C.

References dictionary::lookupOrDefault(), Function1< Type >::New(), surfaceTensionModel::sigmaDict(), and temperatureDependent::writeData().

Referenced by temperatureDependent::sigma().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

Write in dictionary format.

Implements surfaceTensionModel.

Definition at line 122 of file temperatureDependentSurfaceTension.C.

References token::END_STATEMENT, IOstream::good(), Foam::nl, and surfaceTensionModel::writeData().

Referenced by temperatureDependent::readDict().

Here is the call graph for this function:

Here is the caller graph for this function:

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

src/transportModels/interfaceProperties/surfaceTensionModels/temperatureDependent/temperatureDependentSurfaceTension.H
src/transportModels/interfaceProperties/surfaceTensionModels/temperatureDependent/temperatureDependentSurfaceTension.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ temperatureDependent()

◆ ~temperatureDependent()

Member Function Documentation

◆ TypeName()

◆ sigma()

◆ readDict()

◆ writeData()