List container for porosity models. More...

Inheritance diagram for porosityModelList:

Collaboration diagram for porosityModelList:

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

	porosityModelList (const porosityModelList &)=delete
	Disallow default bitwise copy construction. More...

	~porosityModelList ()
	Destructor. More...

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

void	addResistance (fvVectorMatrix &UEqn)
	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...

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

Public Member Functions inherited from PtrList< porosityModel >
	PtrList ()
	Null Constructor. More...

	PtrList (const label)
	Construct with size specified. More...

	PtrList (const PtrList< porosityModel > &)
	Copy constructor. More...

	PtrList (const PtrList< porosityModel > &, const CloneArg &)
	Copy constructor with additional argument for clone. More...

	PtrList (PtrList< porosityModel > &&)
	Move constructor. More...

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

	PtrList (const SLPtrList< porosityModel > &)
	Construct as copy of SLPtrList<T> More...

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

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

	~PtrList ()
	Destructor. More...

void	setSize (const label)
	Reset size of PtrList. If extending the PtrList, new entries are. More...

void	resize (const label)
	Alias for setSize(const label) More...

void	clear ()
	Clear the PtrList, i.e. set size to zero deleting all the. More...

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

void	append (const autoPtr< porosityModel > &)

void	append (const tmp< porosityModel > &)

void	transfer (PtrList< porosityModel > &)
	Transfer the contents of the argument PtrList into this PtrList. More...

bool	set (const label) const
	Is element set. More...

autoPtr< porosityModel >	set (const label, porosityModel *)
	Set element to given T* and return old element (can be nullptr) More...

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

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

void	reorder (const labelUList &oldToNew)
	Reorders elements. Ordering does not have to be done in. More...

void	shuffle (const labelUList &newToOld)
	Reorders elements. Ordering does not have to be done in. More...

void	operator= (const PtrList< porosityModel > &)
	Assignment operator. More...

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

Public Member Functions inherited from UPtrList< T >
	UPtrList ()
	Null Constructor. More...

	UPtrList (const label)
	Construct with size specified. More...

	UPtrList (UPtrList< T > &, bool reuse)
	Construct as copy or re-use as specified. More...

label	size () const
	Return the number of elements in the UPtrList. More...

bool	empty () const
	Return true if the UPtrList is empty (ie, size() is zero) More...

T &	first ()
	Return reference to the first element of the list. More...

const T &	first () const
	Return reference to first element of the list. More...

T &	last ()
	Return reference to the last element of the list. More...

const T &	last () const
	Return reference to the last element of the list. More...

void	setSize (const label)
	Reset size of UPtrList. This can only be used to set the size. More...

void	resize (const label)
	Reset size of UPtrList. This can only be used to set the size. More...

void	clear ()
	Clear the UPtrList, i.e. set size to zero. More...

void	transfer (UPtrList< T > &)
	Transfer the contents of the argument UPtrList into this. More...

bool	set (const label) const
	Is element set. More...

T *	set (const label, T *)
	Set element. Return old element (can be nullptr). More...

void	reorder (const labelUList &oldToNew)
	Reorders elements. Ordering does not have to be done in. More...

void	shuffle (const labelUList &newToOld)
	Reorders elements. Ordering does not have to be done in. More...

const T &	operator[] (const label) const
	Return element const reference. More...

T &	operator[] (const label)
	Return element reference. More...

const T *	operator() (const label) const
	Return element const pointer. More...

iterator	begin ()
	Return an iterator to begin traversing the UPtrList. More...

iterator	end ()
	Return an iterator to end traversing the UPtrList. More...

const_iterator	cbegin () const
	Return an const_iterator to begin traversing the UPtrList. More...

const_iterator	cend () const
	Return an const_iterator to end traversing the UPtrList. More...

const_iterator	begin () const
	Return an const_iterator to begin traversing the UPtrList. More...

const_iterator	end () const
	Return an const_iterator to end traversing the UPtrList. 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
Public Types inherited from UPtrList< T >
typedef T	value_type
	Type of values the UPtrList contains. More...

typedef T &	reference
	Type that can be used for storing into UPtrList::value_type objects. More...

typedef const T &	const_reference
	Type that can be used for storing into constant UPtrList::value_type. More...

Protected Member Functions inherited from PtrList< porosityModel >
void	read (Istream &, const INew &inewt)
	Read from Istream using given Istream constructor class. More...

Detailed Description

List container for porosity models.

Source files

Definition at line 55 of file porosityModelList.H.

Constructor & Destructor Documentation

◆ porosityModelList() [1/2]

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

Definition at line 32 of file porosityModelList.C.

◆ porosityModelList() [2/2]

porosityModelList ( const porosityModelList & )

delete

Disallow default bitwise copy construction.

◆ ~porosityModelList()

~porosityModelList ( )

Destructor.

Definition at line 46 of file porosityModelList.C.

Member Function Documentation

◆ reset()

void reset ( const dictionary & dict )

Reset the source list.

Definition at line 52 of file porosityModelList.C.

References Foam::count(), forAllConstIter(), porosityModelList::mesh_, Foam::name(), porosityModel::New(), and PtrList< porosityModel >::setSize().

Here is the call graph for this function:

◆ addResistance() [1/2]

void addResistance ( fvVectorMatrix & UEqn )

Add resistance.

Definition at line 108 of file porosityModelList.C.

References forAll, and UPtrList< T >::operator[]().

Referenced by porosityModelList::writeData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addResistance() [2/2]

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

Add resistance.

Definition at line 120 of file porosityModelList.C.

References forAll, and UPtrList< T >::operator[]().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

Read dictionary.

Definition at line 82 of file porosityModelList.C.

References forAll, porosityModel::name(), UPtrList< T >::operator[](), 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 95 of file porosityModelList.C.

References porosityModelList::addResistance(), forAll, IOstream::good(), Foam::nl, and UPtrList< T >::operator[]().

Here is the call graph for this function:

◆ operator=()

void operator= ( const porosityModelList & )

delete

Disallow default bitwise assignment.

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 64 of file porosityModelList.H.

Referenced by porosityModelList::reset().

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() [1/2]

◆ porosityModelList() [2/2]

◆ ~porosityModelList()

Member Function Documentation

◆ reset()

◆ addResistance() [1/2]

◆ addResistance() [2/2]

◆ read()

◆ writeData()

◆ operator=()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ mesh_