FreeFOAM The Cross-Platform CFD Toolkit
TimeActivatedExplicitSourceList< Type > Class Template Reference

List of time activeted explict sources. More...

#include <finiteVolume/TimeActivatedExplicitSourceList.H>


Detailed Description

+ Inheritance diagram for TimeActivatedExplicitSourceList< Type >:
+ Collaboration diagram for TimeActivatedExplicitSourceList< Type >:

List of all members.

Public Member Functions

 TimeActivatedExplicitSourceList (const word &name, const fvMesh &mesh, const dimensionSet &dimensions, const wordList &fieldNames)
 Construct from components with list of field names.
 TimeActivatedExplicitSourceList (const word &name, const fvMesh &mesh, const dimensionSet &dimensions, const word &fieldName)
 Construct from components with single field name.
tmp< DimensionedField< Type,
volMesh > > 
Su (const label fieldI=0)
 Return the source for field, fieldI.
tmp< DimensionedField< Type,
volMesh > > 
SuTot ()
 Return the total source for all fields.
bool readData (Istream &is)
 Read data from Istream.
bool writeData (Ostream &os) const
 Write data to Istream.
- Public Member Functions inherited from IOPtrList< TimeActivatedExplicitSource< Type > >
 TypeName ("PtrList")
 Runtime type information.
 IOPtrList (const IOobject &, const INew &)
 Construct from IOobject using given Istream constructor class.
 IOPtrList (const IOobject &)
 Construct from IOobject.
 IOPtrList (const IOobject &, const label)
 Construct from IOobject with given size.
 IOPtrList (const IOobject &, const PtrList< TimeActivatedExplicitSource< Type > > &)
 Construct from IOobject and a PtrList.
 IOPtrList (const IOobject &, const Xfer< PtrList< TimeActivatedExplicitSource< Type > > > &)
 Construct by transferring the PtrList contents.
virtual ~IOPtrList ()
void operator= (const IOPtrList< TimeActivatedExplicitSource< Type > > &)
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information.
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the.
 regIOobject (const regIOobject &)
 Construct as copy.
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, and transferring registry registration to copy.
virtual ~regIOobject ()
bool checkIn ()
 Add object to registry.
bool checkOut ()
 Remove object from registry.
bool ownedByRegistry () const
 Is this object owned by the registry?
void store ()
 Transfer ownership of this object to its registry.
void release ()
 Release ownership of this object from its registry.
label eventNo () const
 Event number at last update.
label & eventNo ()
 Event number at last update.
bool upToDate (const word &) const
 Am I uptodate with respect to other regIOobjects.
bool upToDate (const word &, const word &) const
bool upToDate (const word &, const word &, const word &) const
bool upToDate (const word &, const word &, const word &, const word &) const
void setUpToDate ()
 Flag me as up to date.
virtual void rename (const word &newName)
 Rename.
IstreamreadStream (const word &)
 Return Istream and check object type against that given.
void close ()
 Close Istream.
virtual bool read ()
 Read object.
virtual bool modified () const
 Return true if the object's file has been modified.
virtual bool readIfModified ()
 Read object if modified.
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
 Write using given format, version and compression.
virtual bool write () const
 Write using setting from DB.
void operator= (const IOobject &)
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information.
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options.
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options.
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options.
Foam::autoPtr< IOobjectclone () const
 Clone.
virtual ~IOobject ()
const Timetime () const
 Return time.
const objectRegistrydb () const
 Return the local objectRegistry.
const wordname () const
 Return name.
const wordheaderClassName () const
 Return name of the class name read from header.
stringnote ()
 Return non-constant access to the optional note.
const stringnote () const
 Return the optional note.
bool registerObject () const
 Register object created from this IOobject with registry if true.
readOption readOpt () const
readOptionreadOpt ()
writeOption writeOpt () const
writeOptionwriteOpt ()
const fileNamerootPath () const
const fileNamecaseName () const
const fileNameinstance () const
fileNameinstance ()
const fileNamelocal () const
fileName path () const
 Return complete path.
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local.
fileName objectPath () const
 Return complete path + object name.
fileName filePath () const
 Return complete path + object name if the file exists.
bool readHeader (Istream &)
 Read header.
bool headerOk ()
 Read and check header info.
bool writeHeader (Ostream &) const
 Write header.
bool good () const
bool bad () const
InfoProxy< IOobjectinfo () const
 Return info proxy.
- Public Member Functions inherited from PtrList< TimeActivatedExplicitSource< Type > >
 PtrList ()
 Null Constructor.
 PtrList (const label)
 Construct with length specified.
 PtrList (const PtrList< TimeActivatedExplicitSource< Type > > &)
 Copy constructor.
 PtrList (const PtrList< TimeActivatedExplicitSource< Type > > &, const CloneArg &)
 Copy constructor with additional argument for clone.
 PtrList (const Xfer< PtrList< TimeActivatedExplicitSource< Type > > > &)
 Construct by transferring the parameter contents.
 PtrList (PtrList< TimeActivatedExplicitSource< Type > > &, bool reUse)
 Construct as copy or re-use as specified.
 PtrList (const SLPtrList< TimeActivatedExplicitSource< Type > > &)
 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< TimeActivatedExplicitSource< Type > > &)
 Transfer the contents of the argument PtrList into this PtrList.
Xfer< PtrList
< TimeActivatedExplicitSource
< Type > > > 
xfer ()
 Transfer contents to the Xfer container.
bool set (const label) const
 Is element set.
autoPtr
< TimeActivatedExplicitSource
< Type > > 
set (const label, TimeActivatedExplicitSource< Type > *)
 Set element. Return old element (can be NULL).
autoPtr
< TimeActivatedExplicitSource
< Type > > 
set (const label, const autoPtr< TimeActivatedExplicitSource< Type > > &)
autoPtr
< TimeActivatedExplicitSource
< Type > > 
set (const label, const tmp< TimeActivatedExplicitSource< Type > > &)
void reorder (const UList< label > &)
 Reorders elements. Ordering does not have to be done in.
const
TimeActivatedExplicitSource
< Type > & 
operator[] (const label) const
 Return element const reference.
TimeActivatedExplicitSource
< Type > & 
operator[] (const label)
 Return element reference.
const
TimeActivatedExplicitSource
< Type > * 
operator() (const label) const
 Return element const pointer.
PtrList
< TimeActivatedExplicitSource
< Type > > & 
operator= (const PtrList< TimeActivatedExplicitSource< Type > > &)
 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 TimeActivatedExplicitSourceList &sources)
 Ostream operator.

Constructor & Destructor Documentation

TimeActivatedExplicitSourceList ( const word name,
const fvMesh mesh,
const dimensionSet dimensions,
const wordList fieldNames 
)

Construct from components with list of field names.

Definition at line 32 of file TimeActivatedExplicitSourceList.C.

TimeActivatedExplicitSourceList ( const word name,
const fvMesh mesh,
const dimensionSet dimensions,
const word fieldName 
)

Construct from components with single field name.

Definition at line 60 of file TimeActivatedExplicitSourceList.C.


Member Function Documentation

Foam::tmp< Foam::DimensionedField< Type, Foam::volMesh > > Su ( const label  fieldI = 0)

Return the source for field, fieldI.

Definition at line 94 of file TimeActivatedExplicitSourceList.C.

References forAll, and Foam::fvc::Su().

Return the total source for all fields.

Definition at line 126 of file TimeActivatedExplicitSourceList.C.

References forAll.

bool readData ( Istream is)
virtual

Read data from Istream.

Reimplemented from regIOobject.

Definition at line 160 of file TimeActivatedExplicitSourceList.C.

References clear(), and IOstream::good().

bool writeData ( Ostream os) const
virtual

Write data to Istream.

Reimplemented from IOPtrList< TimeActivatedExplicitSource< Type > >.

Definition at line 185 of file TimeActivatedExplicitSourceList.C.

References forAll, IOstream::good(), and Foam::nl.


Friends And Related Function Documentation

Ostream& operator ( Ostream os,
const TimeActivatedExplicitSourceList< Type > &  sources 
)
friend

Ostream operator.


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