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. Frees all pointers. 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), or nullptr for out-of-range access (ie, with bounds checking). 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, std::unique_ptr< porosityModel > &&ptr)
	Set element to given unique_ptr 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, 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...

autoPtr< porosityModel >	set (const label i, autoPtr< porosityModel > &ptr)
	Set element to given autoPtr 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_back (Args &&... args)
	Construct and append an element to the end of the list. More...

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

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

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

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

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

void	push_back (PtrList< porosityModel > &&other)
	Move append another list to the end of this 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...

void	append (autoPtr< porosityModel > &ptr)
	Move 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 (std::unique_ptr< 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 (const refPtr< porosityModel > &ptr)
	Move or clone append a tmp 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...

void	append (PtrList< porosityModel > &&other)
	Move append another list to the end of this list. More...

Public Member Functions inherited from UPtrList< T >
constexpr	UPtrList () noexcept
	Default construct. More...

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

	UPtrList (const UPtrList< T > &list)
	Copy construct (shallow copies addresses) More...

	UPtrList (UPtrList< T > &&list)
	Move construct. More...

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

	UPtrList (PtrList< T > &list)
	Shallow copy from PtrList. More...

	UPtrList (const UList< T *> &list)
	Construct from UList of pointers (shallow copy) More...

	UPtrList (UList< T > &list)
	Construct from UList, taking the address of each list element. More...

label	size () const noexcept
	The number of elements in the list. More...

bool	empty () const noexcept
	True if the list is empty (ie, size() is zero) More...

T &	front ()
	Reference to the first element of the list. More...

const T &	front () const
	Reference to first element of the list. More...

T &	back ()
	Reference to the last element of the list. More...

const T &	back () const
	Reference to the last element of the list. More...

const T *	test (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...

const T *	get (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...

T *	get (const label i)
	Return pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...

const T *	set (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...

void	clear ()
	Set list size to zero. More...

void	resize (const label newLen)
	Change the size of the list. More...

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

label	squeezeNull ()
	Squeeze out intermediate nullptr entries in the list of pointers. More...

void	push_back (T *ptr)
	Append an element to the end of the list. More...

void	push_back (UPtrList< T > &&other)
	Move append another list to the end of this list. More...

void	swap (UPtrList< T > &list)
	Swap content. More...

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

T *	set (const label i, T *ptr)
	Set element to specified pointer and return the old list element, which can be a nullptr. More...

void	reorder (const labelUList &oldToNew, const bool check=false)
	Reorder elements. Reordering must be unique (ie, shuffle). More...

void	sortOrder (const labelUList &order, const bool check=false)
	Reorder elements according to new order mapping (newToOld). Reordering must be unique (ie, shuffle). More...

void	checkNonNull () const
	Check and raise FatalError if any nullptr exists in the list. More...

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

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

	FOAM_DEPRECATED_FOR (2022-09, "get(), set() or test() methods") const T *operator()(const label i) const
	Deprecated(2022-09) - same as get() More...

void	operator= (const UPtrList< T > &list)
	Copy assignment (shallow copies addresses) More...

void	operator= (UPtrList< T > &&list)
	Move assignment. More...

T **	begin_ptr () noexcept
	Iterator to begin of raw pointers traversal (use with caution) More...

T **	end_ptr () noexcept
	Iterator beyond end of raw pointers traversal (use with caution) More...

iterator	begin () noexcept
	Return an iterator to begin of UPtrList traversal. More...

iterator	end () noexcept
	Return iterator beyond end of UPtrList traversal. More...

const_iterator	cbegin () const noexcept
	Return const_iterator to begin of UPtrList traversal. More...

const_iterator	cend () const noexcept
	Return const_iterator beyond end of UPtrList traversal. More...

const_iterator	begin () const noexcept
	Return const_iterator to begin of UPtrList traversal. More...

const_iterator	end () const noexcept
	Return const_iterator beyond end of UPtrList traversal. More...

T &	first ()
	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	append (T *ptr)
	Append an element to the end of the list. More...

void	append (UPtrList< T > &&other)
	Move append another list to the end of this list. More...

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

Protected Attributes inherited from UPtrList< T >
Detail::PtrListDetail< T >	ptrs_
	The list of pointers. 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 list contains. More...

typedef T &	reference
	A non-const reference to the value_type. More...

typedef const T &	const_reference
	A const reference to the value_type. More...

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

Protected Member Functions inherited from UPtrList< T >
void	setAddressableSize (const label n) noexcept
	Adjust addressable size. More...

	UPtrList (Detail::PtrListDetail< T > &&ptrs)
	Low-level move construct. More...

Detailed Description

List container for porosity models.

Source files

Definition at line 53 of file porosityModelList.H.

Constructor & Destructor Documentation

◆ porosityModelList()

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

Constructor.

Definition at line 27 of file porosityModelList.C.

References dict.

◆ ~porosityModelList()

~porosityModelList ( )

default

Destructor.

Member Function Documentation

◆ active()

bool active ( const bool warn = false ) const

Return active status.

Definition at line 42 of file porosityModelList.C.

References Foam::endl(), forAll, Foam::Info, UPtrList< T >::operator[](), and UPtrList< T >::size().

Here is the call graph for this function:

◆ reset()

void reset ( const dictionary & dict )

Reset the source list.

Definition at line 59 of file porosityModelList.C.

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

Here is the call graph for this function:

◆ addResistance() [1/3]

void addResistance ( fvVectorMatrix & UEqn )

Add resistance.

Definition at line 116 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 128 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 142 of file porosityModelList.C.

References forAll, and UEqn.

◆ read()

bool read ( const dictionary & dict )

Read dictionary.

Definition at line 90 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 103 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 79 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_