Inheritance diagram for DarcyForchheimer:

Collaboration diagram for DarcyForchheimer:

[legend]

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

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

virtual bool	read ()
	Inherit read from 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...

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

Istream &	readStream (const word &)
	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...

label	watchIndex () const
	Return file-monitoring handle. More...

label &	watchIndex ()
	Return file-monitoring handle. 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
	Write using given format, version and compression. More...

virtual bool	write () const
	Write using setting from DB. 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)
	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 word &name)
	Construct as copy resetting name. More...

Foam::autoPtr< IOobject >	clone () const
	Clone. 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...

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

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	filePath () const
	Return complete path + object name if the file exists. More...

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

bool	headerOk ()
	Read and check header info. 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)

Private Member Functions
template<class RhoFieldType >
void	apply (scalarField &Udiag, vectorField &Usource, const scalarField &V, const RhoFieldType &rho, const scalarField &mu, const vectorField &U) const
	Apply. More...

template<class RhoFieldType >
void	apply (tensorField &AU, const RhoFieldType &rho, const scalarField &mu, const vectorField &U) const
	Apply. More...

	DarcyForchheimer (const DarcyForchheimer &)
	Disallow default bitwise copy construct. More...

void	operator= (const DarcyForchheimer &)
	Disallow default bitwise assignment. More...

Private Attributes
dimensionedVector	dXYZ_
	Darcy coeffient XYZ components (user-supplied) [1/m2]. More...

dimensionedVector	fXYZ_
	Forchheimer coeffient XYZ components (user-supplied) [1/m]. More...

List< tensorField >	D_
	Darcy coefficient - converted from dXYZ [1/m2]. More...

List< tensorField >	F_
	Forchheimer coefficient - converted from fXYZ [1/m]. More...

word	rhoName_
	Name of density field. More...

word	muName_
	Name of dynamic viscosity field. More...

word	nuName_
	Name of kinematic viscosity field. More...

Additional Inherited Members
Public Types inherited from regIOobject
enum	fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Types of communications. 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...

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)

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 void	replaceFileName (const word &from, const word &to)

Static Public Attributes inherited from regIOobject
static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static int	fileModificationSkew

static fileCheckTypes	fileModificationChecking

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 IOobject
Istream *	objectStream ()
	Construct and return an IFstream for the object. More...

Istream *	objectStream (const fileName &)
	Construct and return an IFstream for the object given the. More...

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

Definition at line 76 of file DarcyForchheimer.H.

Constructor & Destructor Documentation

◆ DarcyForchheimer() [1/2]

DarcyForchheimer ( const DarcyForchheimer & )

private

Disallow default bitwise copy construct.

◆ DarcyForchheimer() [2/2]

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

◆ apply() [1/2]

void apply	(	scalarField &	Udiag,
		vectorField &	Usource,
		const scalarField &	V,
		const RhoFieldType &	rho,
		const scalarField &	mu,
		const vectorField &	U
	)		const

private

Apply.

Definition at line 30 of file DarcyForchheimerTemplates.C.

References cells, forAll, Foam::I, Foam::mag(), Foam::constant::physicoChemical::mu, rho, Foam::tr(), and U.

Here is the call graph for this function:

◆ apply() [2/2]

void apply	(	tensorField &	AU,
		const RhoFieldType &	rho,
		const scalarField &	mu,
		const vectorField &	U
	)		const

private

Apply.

Definition at line 64 of file DarcyForchheimerTemplates.C.

References cells, Foam::constant::physicoChemical::F, forAll, Foam::mag(), Foam::constant::physicoChemical::mu, rho, and U.

Here is the call graph for this function:

◆ operator=()

void operator= ( const DarcyForchheimer & )

private

Disallow default bitwise assignment.

◆ 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 cells, forAll, IOobject::NO_READ, IOobject::NO_WRITE, R, Tensor::xx(), and Tensor::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 Foam::constant::physicoChemical::mu, rho, U, and Vector< scalar >::zero.

◆ correct() [1/3]

void correct ( fvVectorMatrix & UEqn ) const

virtual

Add resistance.

Implements porosityModel.

Definition at line 190 of file DarcyForchheimer.C.

References Foam::dimForce, IOobject::groupName(), Foam::constant::physicoChemical::mu, nu, rho, U, and UEqn().

Here is the call 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 Foam::constant::physicoChemical::mu, rho, U, and UEqn().

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 Foam::dimForce, IOobject::groupName(), Foam::constant::physicoChemical::mu, nu, rho, U, and UEqn().

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:

Field Documentation

◆ dXYZ_

dimensionedVector dXYZ_

private

Darcy coeffient XYZ components (user-supplied) [1/m2].

Definition at line 83 of file DarcyForchheimer.H.

◆ fXYZ_

dimensionedVector fXYZ_

private

Forchheimer coeffient XYZ components (user-supplied) [1/m].

Definition at line 86 of file DarcyForchheimer.H.

◆ D_

List<tensorField> D_

private

Darcy coefficient - converted from dXYZ [1/m2].

Definition at line 89 of file DarcyForchheimer.H.

◆ F_

List<tensorField> F_

private

Forchheimer coefficient - converted from fXYZ [1/m].

Definition at line 92 of file DarcyForchheimer.H.

◆ rhoName_

word rhoName_

private

Name of density field.

Definition at line 95 of file DarcyForchheimer.H.

◆ muName_

word muName_

private

Name of dynamic viscosity field.

Definition at line 98 of file DarcyForchheimer.H.

◆ nuName_

word nuName_

private

Name of kinematic viscosity field.

Definition at line 101 of file DarcyForchheimer.H.

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

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DarcyForchheimer() [1/2]

◆ DarcyForchheimer() [2/2]

◆ ~DarcyForchheimer()

Member Function Documentation

◆ apply() [1/2]

◆ apply() [2/2]

◆ operator=()

◆ TypeName()

◆ calcTransformModelData()

◆ calcForce()

◆ correct() [1/3]

◆ correct() [2/3]

◆ correct() [3/3]

◆ writeData()

Field Documentation

◆ dXYZ_

◆ fXYZ_

◆ D_

◆ F_

◆ rhoName_

◆ muName_

◆ nuName_