Darcy-Forchheimer law porosity model, given by: More...

Inheritance diagram for DarcyForchheimer:

Collaboration diagram for DarcyForchheimer:

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

	DarcyForchheimer (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict, const word &cellZoneName)
	Constructor. More...

virtual	~DarcyForchheimer ()
	Destructor. More...

virtual void	calcTransformModelData ()
	Transform the model data wrt mesh changes. More...

virtual void	calcForce (const volVectorField &U, const volScalarField &rho, const volScalarField &mu, vectorField &force) const
	Calculate the porosity force. More...

virtual void	correct (fvVectorMatrix &UEqn) const
	Add resistance. More...

virtual void	correct (fvVectorMatrix &UEqn, const volScalarField &rho, const volScalarField &mu) const
	Add resistance. More...

virtual void	correct (const fvVectorMatrix &UEqn, volTensorField &AU) const
	Add resistance. More...

bool	writeData (Ostream &os) const
	Write. More...

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

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

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

virtual	~porosityModel ()
	Destructor. More...

const word &	name () const
	Return const access to the porosity model name. More...

bool	active () const
	Return const access to the porosity active flag. More...

const labelList &	cellZoneIDs () const
	Return const access to the cell zone IDs. More...

const dictionary &	dict () const
	Return dictionary used for model construction. More...

virtual void	transformModelData ()
	Transform the model data wrt mesh changes. More...

virtual tmp< vectorField >	force (const volVectorField &U, const volScalarField &rho, const volScalarField &mu)
	Return the force over the cell zone(s) More...

virtual void	addResistance (fvVectorMatrix &UEqn)
	Add resistance. More...

virtual void	addResistance (fvVectorMatrix &UEqn, const volScalarField &rho, const volScalarField &mu)
	Add resistance. More...

virtual void	addResistance (const fvVectorMatrix &UEqn, volTensorField &AU, bool correctAUprocBC)
	Add resistance. More...

virtual bool	read (const dictionary &dict)
	Read porosity dictionary. 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, transferring 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 porosityModel
static autoPtr< porosityModel >	New (const word &name, const fvMesh &mesh, const dictionary &dict, const word &cellZoneName=word::null)
	Selector. More...

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

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

Protected Member Functions inherited from porosityModel
void	adjustNegativeResistance (dimensionedVector &resist)
	Adjust negative resistance values to be multiplier of max value. More...

label	fieldIndex (const label index) const
	Return label index. 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...

Protected Attributes inherited from porosityModel
word	name_
	Porosity name. More...

const fvMesh &	mesh_
	Reference to the mesh database. More...

const dictionary	dict_
	Dictionary used for model construction. More...

dictionary	coeffs_
	Model coefficients dictionary. More...

bool	active_
	Porosity active flag. More...

keyType	zoneName_
	Name(s) of cell-zone. More...

labelList	cellZoneIDs_
	Cell zone IDs. More...

coordinateSystem	coordSys_
	Local co-ordinate system. More...

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

Detailed Description

Darcy-Forchheimer law porosity model, given by:

$S = - (\mu d + \frac{\rho |U|}{2} f) U$

where

	=	Darcy coefficient [1/m2]
	=	Forchheimer coefficient [1/m]

Since negative Darcy/Forchheimer parameters are invalid, they can be used to specify a multiplier (of the max component).

The orientation of the porous region is defined with the same notation as a co-ordinate system, but only a Cartesian co-ordinate system is valid.

Source files

Definition at line 76 of file DarcyForchheimer.H.

Constructor & Destructor Documentation

◆ DarcyForchheimer()

DarcyForchheimer	(	const word &	name,
		const word &	modelType,
		const fvMesh &	mesh,
		const dictionary &	dict,
		const word &	cellZoneName
	)

Constructor.

Definition at line 46 of file DarcyForchheimer.C.

◆ ~DarcyForchheimer()

~DarcyForchheimer ( )

virtual

Destructor.

Definition at line 72 of file DarcyForchheimer.C.

Member Function Documentation

◆ TypeName()

TypeName ( "DarcyForchheimer" )

Runtime type information.

◆ calcTransformModelData()

void calcTransformModelData ( )

virtual

Transform the model data wrt mesh changes.

Implements porosityModel.

Definition at line 78 of file DarcyForchheimer.C.

References DarcyForchheimer::calcForce(), cells, forAll, IOobject::NO_READ, IOobject::NO_WRITE, R, List< T >::size(), coordinateRotation::transformTensor(), and Foam::Zero.

Here is the call graph for this function:

◆ calcForce()

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

virtual

Calculate the porosity force.

Implements porosityModel.

Definition at line 172 of file DarcyForchheimer.C.

References DarcyForchheimer::correct(), List< T >::size(), and Foam::Zero.

Referenced by DarcyForchheimer::calcTransformModelData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ correct() [1/3]

void correct ( fvVectorMatrix & UEqn ) const

virtual

Add resistance.

Implements porosityModel.

Definition at line 190 of file DarcyForchheimer.C.

References lduMatrix::diag(), fvMatrix< Type >::dimensions(), Foam::dimForce, IOobject::group(), IOobject::groupName(), nu, fvMatrix< Type >::psi(), and fvMatrix< Type >::source().

Referenced by DarcyForchheimer::calcForce(), and DarcyForchheimer::correct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ correct() [2/3]

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

virtual

Add resistance.

Implements porosityModel.

Definition at line 245 of file DarcyForchheimer.C.

References DarcyForchheimer::correct(), lduMatrix::diag(), fvMatrix< Type >::psi(), and fvMatrix< Type >::source().

Here is the call graph for this function:

◆ correct() [3/3]

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

virtual

Add resistance.

Implements porosityModel.

Definition at line 261 of file DarcyForchheimer.C.

References fvMatrix< Type >::dimensions(), Foam::dimForce, IOobject::group(), IOobject::groupName(), nu, and fvMatrix< Type >::psi().

Here is the call graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

Write.

Reimplemented from porosityModel.

Definition at line 301 of file DarcyForchheimer.C.

References Foam::endl(), Foam::indent(), and Ostream::write().

Here is the call graph for this function:

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

src/finiteVolume/cfdTools/general/porosityModel/DarcyForchheimer/DarcyForchheimer.H
src/finiteVolume/cfdTools/general/porosityModel/DarcyForchheimer/DarcyForchheimer.C
src/finiteVolume/cfdTools/general/porosityModel/DarcyForchheimer/DarcyForchheimerTemplates.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DarcyForchheimer()

◆ ~DarcyForchheimer()

Member Function Documentation

◆ TypeName()

◆ calcTransformModelData()

◆ calcForce()

◆ correct() [1/3]

◆ correct() [2/3]

◆ correct() [3/3]

◆ writeData()