A centralized pyrolysis collection. More...

Inheritance diagram for pyrolysisModelCollection:

Collaboration diagram for pyrolysisModelCollection:

Public Member Functions
	TypeName ("pyrolysisModelCollection")

	pyrolysisModelCollection (const fvMesh &)
	Construct from mesh. More...

virtual	~pyrolysisModelCollection ()
	Destructor. More...

virtual void	preEvolveRegion ()
	Pre-evolve regions. More...

virtual void	evolveRegion ()
	Evolve the pyrolysis equation regions. More...

virtual void	evolve ()
	Evolve regions. More...

virtual void	info ()
	Provide some feedback from pyrolysis regions. More...

virtual scalar	maxDiff () const
	Return max diffusivity allowed in the solid. More...

virtual scalar	solidRegionDiffNo () const
	Mean diffusion number of the solid regions. More...

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

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

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

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

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

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

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

	PtrList (const SLPtrList< pyrolysisModel > &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< pyrolysisModel >	clone (Args &&... args) const
	Make a copy by cloning each of the list elements. More...

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

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

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

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

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

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

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

autoPtr< pyrolysisModel >	set (const label i, const tmp< pyrolysisModel > &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 (pyrolysisModel *ptr)
	Append an element to the end of the list. More...

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

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

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

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

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

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

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

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

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

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

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

Additional Inherited Members
Protected Member Functions inherited from PtrList< pyrolysisModel >
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

A centralized pyrolysis collection.

Container class for a set of pyrolysis with functions implemented to loop over the functions for each type.

Source files

Definition at line 62 of file pyrolysisModelCollection.H.

Constructor & Destructor Documentation

◆ pyrolysisModelCollection()

pyrolysisModelCollection ( const fvMesh & mesh )

Construct from mesh.

Definition at line 55 of file pyrolysisModelCollection.C.

References mesh, IOobject::MUST_READ, pyrolysisModel::New(), IOobject::NO_WRITE, PtrList< pyrolysisModel >::set(), PtrList< pyrolysisModel >::setSize(), dictionary::subDict(), and dictionary::toc().

Here is the call graph for this function:

◆ ~pyrolysisModelCollection()

~pyrolysisModelCollection ( )

virtual

Destructor.

Definition at line 93 of file pyrolysisModelCollection.C.

Member Function Documentation

◆ TypeName()

TypeName ( "pyrolysisModelCollection" )

◆ preEvolveRegion()

void preEvolveRegion ( )

virtual

Pre-evolve regions.

Definition at line 100 of file pyrolysisModelCollection.C.

References forAll.

◆ evolveRegion()

void evolveRegion ( )

virtual

Evolve the pyrolysis equation regions.

Definition at line 109 of file pyrolysisModelCollection.C.

References forAll.

◆ evolve()

void evolve ( )

virtual

Evolve regions.

Definition at line 118 of file pyrolysisModelCollection.C.

References Foam::abort(), regionModel::active(), polyMesh::changing(), Foam::decrIndent(), Foam::endl(), regionModel::evolveRegion(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::incrIndent(), Foam::Info, regionModel::info(), regionModel::infoOutput(), regionModel::modelName(), Foam::nl, regionModel::preEvolveRegion(), and regionModel::primaryMesh().

Here is the call graph for this function:

◆ info()

void info ( )

virtual

Provide some feedback from pyrolysis regions.

Definition at line 152 of file pyrolysisModelCollection.C.

References forAll.

◆ maxDiff()

scalar maxDiff ( ) const

virtual

Return max diffusivity allowed in the solid.

Definition at line 161 of file pyrolysisModelCollection.C.

References forAll, and Foam::max().

Here is the call graph for this function:

◆ solidRegionDiffNo()

scalar solidRegionDiffNo ( ) const

virtual

Mean diffusion number of the solid regions.

Definition at line 173 of file pyrolysisModelCollection.C.

References forAll, and Foam::min().

Here is the call graph for this function:

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

src/regionModels/pyrolysisModels/pyrolysisModel/pyrolysisModelCollection.H
src/regionModels/pyrolysisModels/pyrolysisModel/pyrolysisModelCollection.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pyrolysisModelCollection()

◆ ~pyrolysisModelCollection()

Member Function Documentation

◆ TypeName()

◆ preEvolveRegion()

◆ evolveRegion()

◆ evolve()

◆ info()

◆ maxDiff()

◆ solidRegionDiffNo()