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")

	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)

virtual	~surfaceTensionModel ()=default

virtual tmp< volScalarField >	sigma () const =0

bool	writeData (Ostream &os) const

	TypeName ("surfaceTensionModel")

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

	surfaceTensionModel (const fvMesh &mesh)

virtual	~surfaceTensionModel ()

virtual tmp< volScalarField >	sigma () const =0

virtual bool	readDict (const dictionary &dict)=0

virtual bool	writeData (Ostream &os) const =0

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")

	regIOobject (const IOobject &io, const bool isTimeObject=false)

	regIOobject (const regIOobject &rio)

	regIOobject (const regIOobject &rio, bool registerCopy)

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)

	regIOobject (const IOobject &io, const regIOobject &rio)

virtual	~regIOobject ()

bool	checkIn ()

bool	checkOut ()

virtual void	addWatch ()

bool	ownedByRegistry () const

bool	store ()

void	release (const bool unregister=false)

label	eventNo () const

label &	eventNo ()

bool	upToDate (const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const

void	setUpToDate ()

virtual void	rename (const word &newName)

const dictionary *	findMetaData () const noexcept

dictionary &	getMetaData () noexcept

void	removeMetaData ()

virtual void	updateMetaData ()

virtual fileName	filePath () const

bool	headerOk ()

Istream &	readStream (const word &, const bool valid=true)

void	close ()

virtual bool	readData (Istream &)

virtual bool	read ()

virtual label	addWatch (const fileName &)

const labelList &	watchIndices () const

labelList &	watchIndices ()

virtual bool	modified () const

virtual bool	readIfModified ()

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const

virtual bool	write (const bool valid=true) const

virtual bool	global () const

void	operator= (const IOobject &io)

virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const

Public Member Functions inherited from IOobject
	TypeName ("IOobject")

	IOobject (const IOobject &)=default

virtual	~IOobject ()=default

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	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)

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const IOobject &io, const objectRegistry &registry)

	IOobject (const IOobject &io, const word &name)

	IOobject (const IOobject &io, readOption, writeOption)

autoPtr< IOobject >	clone () const

autoPtr< IOobject >	clone (const objectRegistry &registry) const

const objectRegistry &	db () const noexcept

const Time &	time () const

const word &	name () const noexcept

const word &	headerClassName () const noexcept

word &	headerClassName () noexcept

const string &	note () const noexcept

string &	note () noexcept

bool	registerObject () const noexcept

bool	registerObject (bool on) noexcept

bool	globalObject () const noexcept

bool	globalObject (bool on) noexcept

unsigned	labelByteSize () const noexcept

unsigned	scalarByteSize () const noexcept

bool	isHeaderClassName (const word &clsName) const

template<class Type >
bool	isHeaderClassName () const

readOption	readOpt () const noexcept

readOption	readOpt (readOption opt) noexcept

writeOption	writeOpt () const noexcept

writeOption	writeOpt (writeOption opt) noexcept

word	group () const

word	member () const

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

fileName	path () const

fileName	path (const word &instance, const fileName &local=fileName::null) const

fileName	objectPath () const

fileName	objectRelPath () const

fileName	localFilePath (const word &typeName, const bool search=true) const

fileName	globalFilePath (const word &typeName, const bool search=true) const

IOstreamOption	parseHeader (const dictionary &headerDict)

bool	readHeader (Istream &is)

bool	readHeader (dictionary &headerDict, Istream &is)

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)

template<class Type >
void	warnNoRereading () const

bool	writeHeader (Ostream &os) const

bool	writeHeader (Ostream &os, const word &objectType) const

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const

bool	good () const noexcept

bool	bad () const noexcept

InfoProxy< IOobject >	info () const

void	operator= (const IOobject &io)

readOption &	readOpt () noexcept

writeOption &	writeOpt () noexcept

bool &	registerObject () noexcept

bool &	globalObject () noexcept

template<>
bool	isHeaderClassName () const

template<class StringType >
Foam::word	groupName (StringType base, const word &group)

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

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

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)

template<class Type >
static Type &	store (autoPtr< Type > &ptr)

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)

template<class Type >
static Type &	store (refPtr< Type > &ptr)

template<class Type >
static Type &	store (refPtr< Type > &&ptr)

template<class Type >
static Type &	store (tmp< Type > &ptr)

template<class Type >
static Type &	store (tmp< Type > &&ptr)

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept

static bool	bannerEnabled (bool on) noexcept

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)

template<class StringType >
static word	groupName (StringType base, const word &group)

static word	group (const word &name)

static word	member (const word &name)

static word	scopedName (const std::string &scope, const word &name)

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")

static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)

static Ostream &	writeDivider (Ostream &os)

static Ostream &	writeEndDivider (Ostream &os)

Static Public Attributes
static const dimensionSet	dimSigma

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames

static char	scopeSeparator

static fileCheckTypes	fileModificationChecking

static float	fileModificationSkew

static int	maxFileModificationPolls

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

Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)

Protected Attributes
const phasePair &	pair_

const fvMesh &	mesh_

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD, BAD }

enum	readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }

enum	writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }

enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)

Protected Member Functions inherited from IOobject
void	setBad (const string &s)

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false

Detailed Description

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

Source files

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 51 of file surfaceTensionModel.H.

Constructor & Destructor Documentation

◆ surfaceTensionModel() [1/2]

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

Definition at line 39 of file surfaceTensionModel.C.

◆ ~surfaceTensionModel() [1/2]

~surfaceTensionModel ( )

virtualdefault

Definition at line 56 of file surfaceTensionModel.C.

◆ surfaceTensionModel() [2/2]

surfaceTensionModel ( const fvMesh & mesh )

Definition at line 37 of file surfaceTensionModel.C.

◆ ~surfaceTensionModel() [2/2]

virtual ~surfaceTensionModel ( )

virtual

Member Function Documentation

◆ TypeName() [1/2]

TypeName ( "surfaceTensionModel" )

◆ declareRunTimeSelectionTable() [1/2]

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

◆ New() [1/2]

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

static

Definition at line 65 of file surfaceTensionModel.C.

References Foam::abort(), dict, Foam::endl(), Foam::FatalIOError, FatalIOErrorInLookup, and Foam::Info.

Here is the call graph for this function:

◆ sigma() [1/2]

virtual tmp<volScalarField> sigma ( ) const

pure virtual

Implemented in temperatureDependent, liquidProperties, constant, and constantSurfaceTensionCoefficient.

◆ writeData() [1/2]

bool writeData ( Ostream & os ) const

virtual

Implements regIOobject.

Reimplemented in temperatureDependent, liquidProperties, and constant.

Definition at line 94 of file surfaceTensionModel.C.

References os().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sigmaDict()

static const dictionary& sigmaDict ( const dictionary & dict )

inlinestaticprotected

Definition at line 85 of file surfaceTensionModel.H.

References dict.

Referenced by temperatureDependent::readDict().

Here is the caller graph for this function:

◆ TypeName() [2/2]

TypeName ( "surfaceTensionModel" )

◆ declareRunTimeSelectionTable() [2/2]

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

◆ New() [2/2]

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

static

Definition at line 28 of file surfaceTensionModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::get(), Foam::Info, and mesh.

Here is the call graph for this function:

◆ sigma() [2/2]

virtual tmp<volScalarField> sigma ( ) const

pure virtual

Implemented in temperatureDependent, liquidProperties, constant, and constantSurfaceTensionCoefficient.

◆ readDict()

virtual bool readDict ( const dictionary & dict )

pure virtual

Implemented in temperatureDependent, liquidProperties, and constant.

◆ writeData() [2/2]

virtual bool writeData ( Ostream & os ) const

pure virtual

Implements regIOobject.

Implemented in temperatureDependent, liquidProperties, and constant.

Member Data Documentation

◆ pair_

const phasePair& pair_

protected

Definition at line 60 of file surfaceTensionModel.H.

◆ dimSigma

static const dimensionSet dimSigma

static

Definition at line 87 of file surfaceTensionModel.H.

Referenced by phaseSystem::sigma().

◆ mesh_

const fvMesh& mesh_

protected

Definition at line 80 of file surfaceTensionModel.H.

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

src/phaseSystemModels/reactingEuler/multiphaseSystem/interfacialCompositionModels/surfaceTensionModels/surfaceTensionModel/surfaceTensionModel.H
src/phaseSystemModels/reactingEuler/multiphaseSystem/interfacialCompositionModels/surfaceTensionModels/surfaceTensionModel/surfaceTensionModel.C
src/transportModels/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

◆ TypeName() [1/2]

◆ declareRunTimeSelectionTable() [1/2]

◆ New() [1/2]

◆ sigma() [1/2]

◆ writeData() [1/2]

◆ sigmaDict()

◆ TypeName() [2/2]

◆ declareRunTimeSelectionTable() [2/2]

◆ New() [2/2]

◆ sigma() [2/2]

◆ readDict()

◆ writeData() [2/2]

Member Data Documentation

◆ pair_

◆ dimSigma

◆ mesh_