Top level model for porosity models. More...

Inheritance diagram for porosityModel:

[legend]

Collaboration diagram for porosityModel:

[legend]

Classes
class	iNew

Public Member Functions
	TypeName ("porosityModel")

	declareRunTimeSelectionTable (autoPtr, porosityModel, mesh,(const word &modelName, const word &name, const fvMesh &mesh, const dictionary &dict, const word &cellZoneName),(modelName, name, mesh, dict, cellZoneName))

	porosityModel (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict, const word &cellZoneName=word::null)

virtual	~porosityModel ()=default

const word &	name () const

bool	active () const

const labelList &	cellZoneIDs () const

const dictionary &	dict () const

virtual void	transformModelData ()

virtual tmp< vectorField >	force (const volVectorField &U, const volScalarField &rho, const volScalarField &mu)

virtual void	addResistance (fvVectorMatrix &UEqn)

virtual void	addResistance (fvVectorMatrix &UEqn, const volScalarField &rho, const volScalarField &mu)

virtual void	addResistance (const fvVectorMatrix &UEqn, volTensorField &AU, bool correctAUprocBC)

virtual bool	writeData (Ostream &os) const

virtual bool	global () const

virtual fileName	filePath () const

virtual bool	read (const dictionary &dict)

virtual bool	read ()

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

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

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< porosityModel >	New (const word &name, const fvMesh &mesh, const dictionary &dict, const word &cellZoneName=word::null)

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)

Protected Member Functions
virtual void	calcTransformModelData ()=0

void	adjustNegativeResistance (dimensionedVector &resist)

virtual void	calcForce (const volVectorField &U, const volScalarField &rho, const volScalarField &mu, vectorField &force) const =0

virtual void	correct (fvVectorMatrix &UEqn) const =0

virtual void	correct (fvVectorMatrix &UEqn, const volScalarField &rho, const volScalarField &mu) const =0

virtual void	correct (const fvVectorMatrix &UEqn, volTensorField &AU) const =0

const coordinateSystem &	csys () const

label	fieldIndex (const label index) const

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)

Protected Attributes
word	name_

const fvMesh &	mesh_

const dictionary	dict_

dictionary	coeffs_

bool	active_

wordRe	zoneName_

labelList	cellZoneIDs_

autoPtr< coordinateSystem >	csysPtr_

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 }

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

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false

Detailed Description

Top level model for porosity models.

Source files

Definition at line 53 of file porosityModel.H.

Constructor & Destructor Documentation

◆ porosityModel()

porosityModel	(	const word &	name,
		const word &	modelType,
		const fvMesh &	mesh,
		const dictionary &	dict,
		const word &	cellZoneName = `word::null`
	)

Definition at line 64 of file porosityModel.C.

References boundBox::add(), Foam::constant::universal::c, cells, Foam::decrIndent(), dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::incrIndent(), Foam::indent(), Foam::Info, UPstream::master(), Foam::nl, points, dictionary::readIfPresent(), Foam::reduce(), boundBox::reduce(), and boundBox::span().

Here is the call graph for this function:

◆ ~porosityModel()

virtual ~porosityModel ( )

virtualdefault

Member Function Documentation

◆ calcTransformModelData()

virtual void calcTransformModelData ( )

protectedpure virtual

Implemented in solidification, powerLawLopesdaCosta, DarcyForchheimer, powerLaw, and fixedCoeff.

◆ adjustNegativeResistance()

void adjustNegativeResistance ( dimensionedVector & resist )

protected

Definition at line 36 of file porosityModel.C.

References Foam::cmptMax(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, VectorSpace< Vector< scalar >, scalar, 3 >::nComponents, and dimensioned::value().

Here is the call graph for this function:

◆ calcForce()

virtual void calcForce	(	const volVectorField &	U,
		const volScalarField &	rho,
		const volScalarField &	mu,
		vectorField &	force
	)		const

protectedpure virtual

Implemented in solidification, powerLawLopesdaCosta, DarcyForchheimer, powerLaw, and fixedCoeff.

◆ correct() [1/3]

virtual void correct ( fvVectorMatrix & UEqn ) const

protectedpure virtual

Implemented in solidification, powerLawLopesdaCosta, DarcyForchheimer, powerLaw, and fixedCoeff.

◆ correct() [2/3]

virtual void correct	(	fvVectorMatrix &	UEqn,
		const volScalarField &	rho,
		const volScalarField &	mu
	)		const

protectedpure virtual

Implemented in solidification, powerLawLopesdaCosta, DarcyForchheimer, powerLaw, and fixedCoeff.

◆ correct() [3/3]

virtual void correct	(	const fvVectorMatrix &	UEqn,
		volTensorField &	AU
	)		const

protectedpure virtual

Implemented in solidification, powerLawLopesdaCosta, DarcyForchheimer, powerLaw, and fixedCoeff.

◆ csys()

const Foam::coordinateSystem & csys ( ) const

inlineprotected

Definition at line 23 of file porosityModelI.H.

References porosityModel::csysPtr_.

Referenced by DarcyForchheimer::calcTransformModelData().

Here is the caller graph for this function:

◆ fieldIndex()

Foam::label fieldIndex ( const label index ) const

inlineprotected

Definition at line 29 of file porosityModelI.H.

◆ TypeName()

TypeName ( "porosityModel" )

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		porosityModel	,
		mesh	,
		(const word &modelName, const word &name, const fvMesh &mesh, const dictionary &dict, const word &cellZoneName)	,
		(modelName, name, mesh, dict, cellZoneName)
	)

◆ New()

Foam::autoPtr< Foam::porosityModel > New	(	const word &	name,
		const fvMesh &	mesh,
		const dictionary &	dict,
		const word &	cellZoneName = `word::null`
	)

static

Definition at line 27 of file porosityModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, mesh, Foam::name(), and Foam::nl.

Referenced by interRegionExplicitPorositySource::initialise(), porosityModel::iNew::operator()(), and porosityModelList::reset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ name()

const Foam::word & name ( ) const

inline

Definition at line 37 of file porosityModelI.H.

Referenced by porosityModelList::read().

Here is the caller graph for this function:

◆ active()

bool active ( ) const

inline

Definition at line 43 of file porosityModelI.H.

◆ cellZoneIDs()

const Foam::labelList & cellZoneIDs ( ) const

inline

Definition at line 55 of file porosityModelI.H.

Referenced by forces::calcForcesMoment(), forces::initialiseBins(), kEpsilonLopesdaCosta< BasicTurbulenceModel >::setCdSigma(), and kEpsilonLopesdaCosta< BasicTurbulenceModel >::setPorosityCoefficient().

Here is the caller graph for this function:

◆ dict()

const Foam::dictionary & dict ( ) const

inline

Definition at line 49 of file porosityModelI.H.

Referenced by porosityModel::iNew::operator()(), kEpsilonLopesdaCosta< BasicTurbulenceModel >::setCdSigma(), and kEpsilonLopesdaCosta< BasicTurbulenceModel >::setPorosityCoefficient().

Here is the caller graph for this function:

◆ transformModelData()

void transformModelData ( )

virtual

Definition at line 147 of file porosityModel.C.

◆ force()

virtual tmp<vectorField> force	(	const volVectorField &	U,
		const volScalarField &	rho,
		const volScalarField &	mu
	)

virtual

Referenced by forces::calcForcesMoment().

Here is the caller graph for this function:

◆ addResistance() [1/3]

void addResistance ( fvVectorMatrix & UEqn )

virtual

Definition at line 179 of file porosityModel.C.

References correct().

Here is the call graph for this function:

◆ addResistance() [2/3]

void addResistance	(	fvVectorMatrix &	UEqn,
		const volScalarField &	rho,
		const volScalarField &	mu
	)

virtual

Definition at line 192 of file porosityModel.C.

References correct(), Foam::constant::physicoChemical::mu, and rho.

Here is the call graph for this function:

◆ addResistance() [3/3]

void addResistance	(	const fvVectorMatrix &	UEqn,
		volTensorField &	AU,
		bool	correctAUprocBC
	)

virtual

Definition at line 209 of file porosityModel.C.

References correct(), and GeometricField::correctBoundaryConditions().

Here is the call graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

Implements regIOobject.

Reimplemented in solidification, powerLawLopesdaCosta, DarcyForchheimer, powerLaw, and fixedCoeff.

Definition at line 233 of file porosityModel.C.

◆ global()

virtual bool global ( ) const

inlinevirtual

Reimplemented from regIOobject.

Definition at line 269 of file porosityModel.H.

◆ filePath()

virtual fileName filePath ( ) const

inlinevirtual

Reimplemented from regIOobject.

Definition at line 276 of file porosityModel.H.

References IOobject::globalFilePath(), and Foam::type().

Here is the call graph for this function:

◆ read() [1/2]

bool read ( const dictionary & dict )

virtual

Definition at line 239 of file porosityModel.C.

References dict, dictionary::optionalSubDict(), dictionary::readEntry(), dictionary::readIfPresent(), and Foam::type().

Referenced by porosityModelList::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read() [2/2]

bool read

Definition at line 184 of file regIOobjectRead.C.

Member Data Documentation

◆ name_

word name_

protected

Definition at line 71 of file porosityModel.H.

◆ mesh_

const fvMesh& mesh_

protected

Definition at line 74 of file porosityModel.H.

Referenced by DarcyForchheimer::calcTransformModelData().

◆ dict_

const dictionary dict_

protected

Definition at line 77 of file porosityModel.H.

◆ coeffs_

dictionary coeffs_

protected

Definition at line 80 of file porosityModel.H.

◆ active_

bool active_

protected

Definition at line 83 of file porosityModel.H.

◆ zoneName_

wordRe zoneName_

protected

Definition at line 86 of file porosityModel.H.

◆ cellZoneIDs_

labelList cellZoneIDs_

protected

Definition at line 89 of file porosityModel.H.

Referenced by DarcyForchheimer::calcTransformModelData().

◆ csysPtr_

autoPtr<coordinateSystem> csysPtr_

protected

Definition at line 92 of file porosityModel.H.

Referenced by porosityModel::csys().

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

src/finiteVolume/cfdTools/general/porosityModel/porosityModel/porosityModel.H
src/finiteVolume/cfdTools/general/porosityModel/porosityModel/porosityModel.C
src/finiteVolume/cfdTools/general/porosityModel/porosityModel/porosityModelI.H
src/finiteVolume/cfdTools/general/porosityModel/porosityModel/porosityModelNew.C

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ porosityModel()

◆ ~porosityModel()

Member Function Documentation

◆ calcTransformModelData()

◆ adjustNegativeResistance()

◆ calcForce()

◆ correct() [1/3]

◆ correct() [2/3]

◆ correct() [3/3]

◆ csys()

◆ fieldIndex()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ name()

◆ active()

◆ cellZoneIDs()

◆ dict()

◆ transformModelData()

◆ force()

◆ addResistance() [1/3]

◆ addResistance() [2/3]

◆ addResistance() [3/3]

◆ writeData()

◆ global()

◆ filePath()

◆ read() [1/2]

◆ read() [2/2]

Member Data Documentation

◆ name_

◆ mesh_

◆ dict_

◆ coeffs_

◆ active_

◆ zoneName_

◆ cellZoneIDs_

◆ csysPtr_