FreeFOAM The Cross-Platform CFD Toolkit
basicSourceList Class Reference

List of explict sources. More...

#include <finiteVolume/basicSourceList.H>


Detailed Description

List of explict sources.

SourceFile basicSourceList.C

Definition at line 51 of file basicSourceList.H.

+ Inheritance diagram for basicSourceList:
+ Collaboration diagram for basicSourceList:

List of all members.

Public Member Functions

 basicSourceList (const fvMesh &mesh, const dictionary &dict)
 Construct from components with list of field names.
virtual ~basicSourceList ()
 Destructor.
void addExplicitSources ()
 Add all explicit sources.
void addSu (DimensionedField< scalar, volMesh > &field)
 Add source to scalar field.
void addSu (DimensionedField< vector, volMesh > &field)
 Add source to vector field.
void addSu (fvMatrix< scalar > &Eq)
 Add source terms to scalar fvMatrix.
void addSu (fvMatrix< vector > &Eq)
 Add source terms to vector fvMatrix.
virtual bool read (const dictionary &dict)
 Read dictionary.
virtual bool writeData (Ostream &os) const
 Write data to Istream.
- Public Member Functions inherited from PtrList< basicSource >
 PtrList ()
 Null Constructor.
 PtrList (const label)
 Construct with length specified.
 PtrList (const PtrList< basicSource > &)
 Copy constructor.
 PtrList (const PtrList< basicSource > &, const CloneArg &)
 Copy constructor with additional argument for clone.
 PtrList (const Xfer< PtrList< basicSource > > &)
 Construct by transferring the parameter contents.
 PtrList (PtrList< basicSource > &, bool reUse)
 Construct as copy or re-use as specified.
 PtrList (const SLPtrList< basicSource > &)
 Construct as copy of SLPtrList<T>
 PtrList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class.
 PtrList (Istream &)
 Construct from Istream using default Istream constructor class.
 ~PtrList ()
label size () const
 Return the number of elements in the PtrList.
bool empty () const
 Return true if the PtrList is empty (ie, size() is zero).
void setSize (const label)
 Reset size of PtrList. This can only be used to set the size.
void resize (const label)
 Reset size of PtrList. This can only be used to set the size.
void clear ()
 Clear the PtrList, i.e. set size to zero deleting all the.
void transfer (PtrList< basicSource > &)
 Transfer the contents of the argument PtrList into this PtrList.
Xfer< PtrList< basicSource > > xfer ()
 Transfer contents to the Xfer container.
bool set (const label) const
 Is element set.
autoPtr< basicSourceset (const label, basicSource *)
 Set element. Return old element (can be NULL).
autoPtr< basicSourceset (const label, const autoPtr< basicSource > &)
autoPtr< basicSourceset (const label, const tmp< basicSource > &)
void reorder (const UList< label > &)
 Reorders elements. Ordering does not have to be done in.
const basicSourceoperator[] (const label) const
 Return element const reference.
basicSourceoperator[] (const label)
 Return element reference.
const basicSourceoperator() (const label) const
 Return element const pointer.
PtrList< basicSource > & operator= (const PtrList< basicSource > &)
 Assignment.
iterator begin ()
 Return an iterator to begin traversing the PtrList.
iterator end ()
 Return an iterator to end traversing the PtrList.

Friends

Ostreamoperator<< (Ostream &os, const basicSourceList &sources)
 Ostream operator.

Additional Inherited Members

- Public Types inherited from PtrList< basicSource >
typedef basicSource value_type
 Type of values the PtrList contains.
typedef basicSourcereference
 Type that can be used for storing into PtrList::value_type objects.
typedef const basicSourceconst_reference
 Type that can be used for storing into constant PtrList::value_type.
- Protected Member Functions inherited from PtrList< basicSource >
void read (Istream &, const INew &inewt)
 Read from Istream using given Istream constructor class.

Constructor & Destructor Documentation

basicSourceList ( const fvMesh mesh,
const dictionary dict 
)

Construct from components with list of field names.

Definition at line 31 of file basicSourceList.C.

References forAllConstIter, name(), and setSize().

virtual ~basicSourceList ( )
inlinevirtual

Destructor.

Definition at line 81 of file basicSourceList.H.


Member Function Documentation

void addExplicitSources ( )

Add all explicit sources.

Definition at line 93 of file basicSourceList.C.

References forAll.

void addSu ( DimensionedField< scalar, volMesh > &  field)

Add source to scalar field.

Definition at line 107 of file basicSourceList.C.

References forAll.

void addSu ( DimensionedField< vector, volMesh > &  field)

Add source to vector field.

Definition at line 122 of file basicSourceList.C.

References forAll.

void addSu ( fvMatrix< scalar > &  Eq)

Add source terms to scalar fvMatrix.

Definition at line 68 of file basicSourceList.C.

References basicSource::addSu(), forAll, and PtrList< basicSource >::operator[]().

void addSu ( fvMatrix< vector > &  Eq)

Add source terms to vector fvMatrix.

Definition at line 80 of file basicSourceList.C.

References forAll.

bool read ( const dictionary dict)
virtual

Read dictionary.

Definition at line 136 of file basicSourceList.C.

References forAll.

bool writeData ( Ostream os) const
virtual

Write data to Istream.

Definition at line 146 of file basicSourceList.C.

References token::BEGIN_LIST, token::END_LIST, token::END_STATEMENT, forAll, IOstream::good(), and Foam::nl.


Friends And Related Function Documentation

Ostream& operator<< ( Ostream os,
const basicSourceList sources 
)
friend

Ostream operator.


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