Wrapper class for interfacial models for which multiple instances of the model are used for different configurations of the interface; e.g., bubbles, droplets, segregated flow, displaced by another phase, ... The values generated by these multiple models are then "blended" to create a single effective coefficient or source. More...

Inheritance diagram for BlendedInterfacialModel< ModelType >:

[legend]

Collaboration diagram for BlendedInterfacialModel< ModelType >:

[legend]

Public Types
typedef ModelType	modelType
	Public Type Definitions. More...

typedef TypeSet	requiredPhaseInterfaces
	Required phase interface types. More...

typedef TypeSet< dispersedPhaseInterface, segregatedPhaseInterface, displacedPhaseInterface >	allowedPhaseInterfaces
	Allowed phase interface types. More...

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

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

template<class ... Args>
	BlendedInterfacialModel (const dictionary &dict, const phaseInterface &interface, const dictionary &blendingDict, const Args &... args)
	Construct from a dictionary, an interface and a blending dictionary. More...

	BlendedInterfacialModel (const BlendedInterfacialModel< ModelType > &)=delete
	Disallow default bitwise copy construction. More...

	~BlendedInterfacialModel ()
	Destructor. More...

const phaseInterface &	interface () const
	Access the interface. More...

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

void	operator= (const BlendedInterfacialModel< ModelType > &)=delete
	Disallow default bitwise assignment. More...

template<class Type , class GeoMesh , class ... Args>
Foam::tmp< Foam::GeometricField< Type, GeoMesh > >	evaluate (tmp< GeometricField< Type, GeoMesh >>(ModelType::*method)(Args ...) const, const word &name, const dimensionSet &dims, Args ... args) const

template<class Type , class GeoMesh , class ... Args>
Foam::HashPtrTable< Foam::GeometricField< Type, GeoMesh > >	evaluate (HashPtrTable< GeometricField< Type, GeoMesh >>(ModelType::*method)(Args ...) const, const word &name, const dimensionSet &dims, Args ... args) const

template<class ... Args>
Foam::hashedWordList	evaluate (const hashedWordList &(ModelType::*method)(Args ...) const, Args ... args) const

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 (regIOobject &&)
	Move 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...

virtual bool	global () const
	Return true if object is global, i.e. same for all processors. More...

virtual bool	globalFile () const
	Return true if object is global, i.e. same for all processors. More...

const fileName &	caseName () const

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

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

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

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

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

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

bool	registered () const
	Is this object registered with the registry? 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...

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

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	dependenciesModified () const
	Return true if the object's dependencies have been modified. 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 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 &)=delete
	Assign to IOobject. More...

void	operator= (const regIOobject &)=delete
	Disallow default assignment. More...

const fileName &	caseName (const bool global) const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

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

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

const fileName &	rootPath () const

const fileName &	caseName (const bool global) const

fileName &	instance () const
	Return the instance directory, constant, system, <time> etc. More...

void	updateInstance () const
	If the instance is a time directory update to the current time. More...

void	updateTimeInstance () const
	Update instance to the current time. More...

const fileName &	local () const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

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

fileName	relativeObjectPath () const
	Return complete relativePath + object name. More...

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

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

bool	headerOk ()
	Read header of local object without type-checking. 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)

Protected Member Functions
template<class Type , class GeoMesh , class ... Args>
tmp< GeometricField< Type, GeoMesh > >	evaluate (tmp< GeometricField< Type, GeoMesh >>(ModelType::*method)(Args ...) const, const word &name, const dimensionSet &dims, Args ... args) const
	Return a blended field. More...

template<class Type , class GeoMesh , class ... Args>
HashPtrTable< GeometricField< Type, GeoMesh > >	evaluate (HashPtrTable< GeometricField< Type, GeoMesh >>(ModelType::*method)(Args ...) const, const word &name, const dimensionSet &dims, Args ... args) const
	Return a table of blended fields. More...

template<class ... Args>
bool	evaluate (bool(ModelType::*method)(Args ...) const, Args ... args) const
	Return a bool combined (or) from all models. More...

template<class ... Args>
hashedWordList	evaluate (const hashedWordList &(ModelType::*method)(Args ...) const, Args ... args) const
	Return a hashed word list combined from all models. More...

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

Protected Member Functions inherited from IOobject
template<class Type >
bool	typeHeaderOk (const bool checkType)
	Read header using typeGlobalFile to find file. More...

Additional Inherited Members
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 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 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...

Detailed Description

template<class ModelType>
class Foam::BlendedInterfacialModel< ModelType >

Wrapper class for interfacial models for which multiple instances of the model are used for different configurations of the interface; e.g., bubbles, droplets, segregated flow, displaced by another phase, ... The values generated by these multiple models are then "blended" to create a single effective coefficient or source.

Source files

Definition at line 58 of file BlendedInterfacialModel.H.

Member Typedef Documentation

◆ modelType

typedef ModelType modelType

Public Type Definitions.

The underlying model type

Definition at line 172 of file BlendedInterfacialModel.H.

◆ requiredPhaseInterfaces

typedef TypeSet requiredPhaseInterfaces

Required phase interface types.

Definition at line 175 of file BlendedInterfacialModel.H.

◆ allowedPhaseInterfaces

typedef TypeSet< dispersedPhaseInterface, segregatedPhaseInterface, displacedPhaseInterface > allowedPhaseInterfaces

Allowed phase interface types.

Definition at line 183 of file BlendedInterfacialModel.H.

Constructor & Destructor Documentation

◆ BlendedInterfacialModel() [1/2]

BlendedInterfacialModel	(	const dictionary &	dict,
		const phaseInterface &	interface,
		const dictionary &	blendingDict,
		const Args &...	args
	)

Construct from a dictionary, an interface and a blending dictionary.

Definition at line 1144 of file BlendedInterfacialModel.C.

References args, Foam::blendingDict(), dict, phaseInterface::fluid(), forAll, format(), dictionary::found(), Foam::generateInterfacialModels(), phaseModel::index(), phaseInterface::index(), BlendedInterfacialModel< ModelType >::interface(), dictionary::lookup(), phaseSystem::phases(), and PtrList< T >::set().

Here is the call graph for this function:

◆ BlendedInterfacialModel() [2/2]

BlendedInterfacialModel ( const BlendedInterfacialModel< ModelType > & )

delete

Disallow default bitwise copy construction.

◆ ~BlendedInterfacialModel()

~BlendedInterfacialModel

Destructor.

Definition at line 1268 of file BlendedInterfacialModel.C.

Member Function Documentation

◆ evaluate() [1/7]

tmp<GeometricField<Type, GeoMesh> > evaluate	(	tmp< GeometricField< Type, GeoMesh >>(ModelType::*)(Args ...) const	method,
		const word &	name,
		const dimensionSet &	dims,
		Args ...	args
	)		const

protected

Return a blended field.

◆ evaluate() [2/7]

HashPtrTable<GeometricField<Type, GeoMesh> > evaluate	(	HashPtrTable< GeometricField< Type, GeoMesh >>(ModelType::*)(Args ...) const	method,
		const word &	name,
		const dimensionSet &	dims,
		Args ...	args
	)		const

protected

Return a table of blended fields.

◆ evaluate() [3/7]

bool evaluate	(	bool(ModelType::*)(Args ...) const	method,
		Args ...	args
	)		const

protected

Return a bool combined (or) from all models.

Definition at line 1016 of file BlendedInterfacialModel.C.

References args, and forAll.

◆ evaluate() [4/7]

hashedWordList evaluate	(	const hashedWordList &(ModelType::*)(Args ...) const	method,
		Args ...	args
	)		const

protected

Return a hashed word list combined from all models.

◆ TypeName()

TypeName ( "BlendedInterfacialModel< ModelType >" )

Runtime type information.

◆ interface()

const Foam::phaseInterface & interface

Access the interface.

Definition at line 1276 of file BlendedInterfacialModel.C.

Referenced by BlendedInterfacialModel< ModelType >::BlendedInterfacialModel().

Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

Dummy write for regIOobject.

Implements regIOobject.

Definition at line 1283 of file BlendedInterfacialModel.C.

References IOstream::good().

Here is the call graph for this function:

◆ operator=()

void operator= ( const BlendedInterfacialModel< ModelType > & )

delete

Disallow default bitwise assignment.

◆ evaluate() [5/7]

Foam::tmp<Foam::GeometricField<Type, GeoMesh> > evaluate	(	tmp< GeometricField< Type, GeoMesh >>(ModelType::*)(Args ...) const	method,
		const word &	name,
		const dimensionSet &	dims,
		Args ...	args
	)		const

Definition at line 804 of file BlendedInterfacialModel.C.

References args, forAll, Foam::name(), Foam::compressible::New(), x, and Foam::Zero.

Here is the call graph for this function:

◆ evaluate() [6/7]

Foam::HashPtrTable<Foam::GeometricField<Type, GeoMesh> > evaluate	(	HashPtrTable< GeometricField< Type, GeoMesh >>(ModelType::*)(Args ...) const	method,
		const word &	name,
		const dimensionSet &	dims,
		Args ...	args
	)		const

Definition at line 894 of file BlendedInterfacialModel.C.

References args, f(), forAll, forAllConstIter, HashTable< T, Key, Hash >::found(), HashTable< T, Key, Hash >::insert(), Foam::name(), and Foam::compressible::New().

Here is the call graph for this function:

◆ evaluate() [7/7]

Foam::hashedWordList evaluate	(	const hashedWordList &(ModelType::*)(Args ...) const	method,
		Args ...	args
	)		const

Definition at line 1077 of file BlendedInterfacialModel.C.

References List< T >::append(), args, and forAll.

Here is the call graph for this function:

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

applications/modules/multiphaseEuler/phaseSystem/interfacialModels/BlendedInterfacialModel/BlendedInterfacialModel.H
applications/modules/multiphaseEuler/phaseSystem/interfacialModels/BlendedInterfacialModel/BlendedInterfacialModel.C

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

template<class ModelType> class Foam::BlendedInterfacialModel< ModelType >

Member Typedef Documentation

◆ modelType

◆ requiredPhaseInterfaces

◆ allowedPhaseInterfaces

Constructor & Destructor Documentation

◆ BlendedInterfacialModel() [1/2]

◆ BlendedInterfacialModel() [2/2]

◆ ~BlendedInterfacialModel()

Member Function Documentation

◆ evaluate() [1/7]

◆ evaluate() [2/7]

◆ evaluate() [3/7]

◆ evaluate() [4/7]

◆ TypeName()

◆ interface()

◆ writeData()

◆ operator=()

◆ evaluate() [5/7]

◆ evaluate() [6/7]

◆ evaluate() [7/7]

template<class ModelType>
class Foam::BlendedInterfacialModel< ModelType >