List container for porosity models. More...

Inheritance diagram for porosityModelList:

Collaboration diagram for porosityModelList:

Public Member Functions
	porosityModelList (const fvMesh &mesh, const dictionary &dict)
	Constructor. More...

	~porosityModelList ()=default
	Destructor. More...

bool	active (const bool warn=false) const
	Return active status. More...

void	reset (const dictionary &dict)
	Reset the source list. More...

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

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

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

bool	read (const dictionary &dict)
	Read dictionary. More...

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

Public Member Functions inherited from PtrList< porosityModel >
constexpr	PtrList () noexcept
	Default construct. More...

	PtrList (const label len)
	Construct with specified size, each element initialized to nullptr. More...

	PtrList (const PtrList< porosityModel > &list)
	Copy construct using 'clone()' method on each element. More...

	PtrList (PtrList< porosityModel > &&list)
	Move construct. More...

	PtrList (UList< porosityModel * > &list)
	Take ownership of pointers in the list, set old pointers to null. More...

	PtrList (const PtrList< porosityModel > &list, const CloneArg &cloneArgs)
	Copy construct using 'clone()' method on each element. More...

	PtrList (PtrList< porosityModel > &list, bool reuse)
	Construct as copy or re-use as specified. More...

	PtrList (const SLPtrList< porosityModel > &list)
	Copy construct using 'clone()' on each element of SLPtrList<T> More...

	PtrList (Istream &is, const INew &inew)
	Construct from Istream using given Istream constructor class. More...

	PtrList (Istream &is)
	Construct from Istream using default Istream constructor class. More...

	~PtrList ()
	Destructor. More...

PtrList< porosityModel >	clone (Args &&... args) const
	Make a copy by cloning each of the list elements. More...

Foam::PtrList< porosityModel >	clone (Args &&... args) const

const porosityModel *	set (const label i) const
	Return const pointer to element (can be nullptr),. More...

autoPtr< porosityModel >	set (const label i, porosityModel *ptr)
	Set element to given pointer and return old element (can be null) More...

autoPtr< porosityModel >	set (const label i, autoPtr< porosityModel > &ptr)
	Set element to given autoPtr and return old element. More...

autoPtr< porosityModel >	set (const label i, autoPtr< porosityModel > &&ptr)
	Set element to given autoPtr and return old element. More...

autoPtr< porosityModel >	set (const label i, std::unique_ptr< porosityModel > &&ptr)
	Set element to given unique_ptr and return old element. More...

autoPtr< porosityModel >	set (const label i, const refPtr< porosityModel > &ptr)
	Set element to given refPtr and return old element. More...

autoPtr< porosityModel >	set (const label i, const tmp< porosityModel > &ptr)
	Set element to given tmp and return old element. More...

void	clear ()
	Clear the PtrList. Delete allocated entries and set size to zero. More...

void	resize (const label newLen)
	Adjust size of PtrList. More...

void	setSize (const label newLen)
	Same as resize() More...

void	emplace_append (Args &&... args)
	Construct and append an element to the end of the list. More...

void	append (porosityModel *ptr)
	Append an element to the end of the list. More...

void	append (autoPtr< porosityModel > &ptr)
	Move append an element to the end of the list. More...

void	append (autoPtr< porosityModel > &&ptr)
	Move append an element to the end of the list. More...

void	append (std::unique_ptr< porosityModel > &&ptr)
	Move append an element to the end of the list. More...

void	append (const refPtr< porosityModel > &ptr)
	Move or clone append a refPtr to the end of the list. More...

void	append (const tmp< porosityModel > &ptr)
	Move or clone append a tmp to the end of the list. More...

autoPtr< porosityModel >	emplace (const label i, Args &&... args)
	Construct and set an element. More...

Foam::autoPtr< porosityModel >	emplace (const label i, Args &&... args)

autoPtr< porosityModel >	release (const label i)
	Release ownership of the pointer at the given position. More...

void	transfer (PtrList< porosityModel > &list)
	Transfer into this list and annul the argument list. More...

void	operator= (const PtrList< porosityModel > &list)
	Copy assignment. More...

void	operator= (PtrList< porosityModel > &&list)
	Move assignment. More...

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

Friends
Ostream &	operator<< (Ostream &os, const porosityModelList &models)
	Ostream operator. More...

Additional Inherited Members
Protected Member Functions inherited from PtrList< porosityModel >
void	readIstream (Istream &is, const INew &inew)
	Read from Istream using Istream constructor class. More...

void	free ()
	Delete the allocated entries, but retain the list size. More...

Detailed Description

List container for porosity models.

Source files

Definition at line 57 of file porosityModelList.H.

Constructor & Destructor Documentation

◆ porosityModelList()

porosityModelList	(	const fvMesh &	mesh,
		const dictionary &	dict
	)

Constructor.

Definition at line 34 of file porosityModelList.C.

References dict, and reset().

Here is the call graph for this function:

◆ ~porosityModelList()

~porosityModelList ( )

default

Destructor.

Member Function Documentation

◆ active()

bool active ( const bool warn = false ) const

Return active status.

Definition at line 49 of file porosityModelList.C.

References Foam::endl(), forAll, and Foam::Info.

Here is the call graph for this function:

◆ reset()

void reset ( const dictionary & dict )

Reset the source list.

Definition at line 66 of file porosityModelList.C.

References Foam::BitOps::count(), dict, Foam::name(), porosityModel::New(), resize(), and Foam::BitOps::set().

Here is the call graph for this function:

◆ addResistance() [1/3]

void addResistance ( fvVectorMatrix & UEqn )

Add resistance.

Definition at line 123 of file porosityModelList.C.

References forAll, and UEqn.

◆ addResistance() [2/3]

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

Add resistance.

Definition at line 135 of file porosityModelList.C.

References forAll, Foam::constant::physicoChemical::mu, rho, and UEqn.

◆ addResistance() [3/3]

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

Add resistance.

Definition at line 149 of file porosityModelList.C.

References forAll, and UEqn.

◆ read()

bool read ( const dictionary & dict )

Read dictionary.

Definition at line 97 of file porosityModelList.C.

References dict, forAll, porosityModel::name(), porosityModel::read(), and dictionary::subDict().

Referenced by IOporosityModelList::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

Write data to Ostream.

Definition at line 110 of file porosityModelList.C.

References forAll, IOstream::good(), Foam::nl, and os().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<<	(	Ostream &	os,
		const porosityModelList &	models
	)

friend

Ostream operator.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

Reference to the mesh database.

Definition at line 77 of file porosityModelList.H.

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

src/finiteVolume/cfdTools/general/porosityModel/porosityModel/porosityModelList.H
src/finiteVolume/cfdTools/general/porosityModel/porosityModel/porosityModelList.C

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ porosityModelList()

◆ ~porosityModelList()

Member Function Documentation

◆ active()

◆ reset()

◆ addResistance() [1/3]

◆ addResistance() [2/3]

◆ addResistance() [3/3]

◆ read()

◆ writeData()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ mesh_