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 ()
 Destructor. More...
 
bool active (const bool active=false) const
 Return active status. More...
 
void reset (const dictionary &dict)
 Reset the source list. More...
 
void addResistance (fvVectorMatrix &UEqn) const
 Add resistance. More...
 
void addResistance (fvVectorMatrix &UEqn, const volScalarField &rho, const volScalarField &mu) const
 Add resistance. More...
 
void addResistance (const fvVectorMatrix &UEqn, volTensorField &AU, bool correctAUprocBC=true) const
 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< T >
 PtrList ()
 Null Constructor. More...
 
 PtrList (const label)
 Construct with size specified. More...
 
 PtrList (const PtrList< T > &)
 Copy constructor. More...
 
template<class CloneArg >
 PtrList (const PtrList< T > &, const CloneArg &)
 Copy constructor with additional argument for clone. More...
 
 PtrList (const Xfer< PtrList< T > > &)
 Construct by transferring the parameter contents. More...
 
 PtrList (PtrList< T > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< T > &)
 Construct as copy of SLPtrList<T> More...
 
template<class INew >
 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...
 
label size () const
 Return the number of elements in the PtrList. More...
 
bool empty () const
 Return true if the PtrList is empty (ie, size() is zero). More...
 
Tfirst ()
 Return reference to the first element of the list. More...
 
const Tfirst () const
 Return reference to first element of the list. More...
 
Tlast ()
 Return reference to the last element of the list. More...
 
const Tlast () const
 Return reference to the last element of the list. 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 (T *)
 Append an element at the end of the list. More...
 
void append (const autoPtr< T > &)
 
void append (const tmp< T > &)
 
void transfer (PtrList< T > &)
 Transfer the contents of the argument PtrList into this PtrList. More...
 
Xfer< PtrList< T > > xfer ()
 Transfer contents to the Xfer container. More...
 
bool set (const label) const
 Is element set. More...
 
autoPtr< Tset (const label, T *)
 Set element. Return old element (can be NULL). More...
 
autoPtr< Tset (const label, const autoPtr< T > &)
 
autoPtr< Tset (const label, const tmp< T > &)
 
void reorder (const labelUList &)
 Reorders elements. Ordering does not have to be done in. More...
 
const Toperator[] (const label) const
 Return element const reference. More...
 
Toperator[] (const label)
 Return element reference. More...
 
const Toperator() (const label) const
 Return element const pointer. More...
 
PtrList< T > & operator= (const PtrList< T > &)
 Assignment. More...
 
iterator begin ()
 Return an iterator to begin traversing the PtrList. More...
 
iterator end ()
 Return an iterator to end traversing the PtrList. More...
 

Protected Attributes

const fvMeshmesh_
 Reference to the mesh database. More...
 

Friends

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

Additional Inherited Members

- Public Types inherited from PtrList< T >
typedef T value_type
 Type of values the PtrList contains. More...
 
typedef Treference
 Type that can be used for storing into PtrList::value_type objects. More...
 
typedef const Tconst_reference
 Type that can be used for storing into constant PtrList::value_type. More...
 
- Protected Member Functions inherited from PtrList< T >
template<class INew >
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 56 of file porosityModelList.H.

Constructor & Destructor Documentation

porosityModelList ( const fvMesh mesh,
const dictionary dict 
)

Constructor.

Definition at line 32 of file porosityModelList.C.

Destructor.

Definition at line 48 of file porosityModelList.C.

References porosityModelList::~porosityModelList().

Referenced by porosityModelList::~porosityModelList().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

bool active ( const bool  active = false) const

Return active status.

Definition at line 54 of file porosityModelList.C.

References porosityModelList::active(), Foam::endl(), and forAll.

Referenced by porosityModelList::active().

Here is the call graph for this function:

Here is the caller graph for this function:

void reset ( const dictionary dict)

Reset the source list.

Definition at line 71 of file porosityModelList.C.

References forAllConstIter, iter, name(), porosityModelList::reset(), and setSize().

Referenced by porosityModelList::reset().

Here is the call graph for this function:

Here is the caller graph for this function:

void addResistance ( fvVectorMatrix UEqn) const

Add resistance.

Definition at line 127 of file porosityModelList.C.

References forAll.

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

Add resistance.

Definition at line 139 of file porosityModelList.C.

References forAll.

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

Add resistance.

Definition at line 153 of file porosityModelList.C.

References forAll.

bool read ( const dictionary dict)

Read dictionary.

Definition at line 101 of file porosityModelList.C.

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

Referenced by porosityModelList::read().

Here is the call graph for this function:

Here is the caller graph for this function:

bool writeData ( Ostream os) const

Write data to Ostream.

Definition at line 114 of file porosityModelList.C.

References forAll, and IOstream::good().

Here is the call graph for this function:

Friends And Related Function Documentation

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

Ostream operator.

Member Data Documentation

const fvMesh& mesh_
protected

Reference to the mesh database.

Definition at line 76 of file porosityModelList.H.


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