FreeFOAM The Cross-Platform CFD Toolkit
centredCECCellToFaceStencilObject Class Reference

#include <finiteVolume/centredCECCellToFaceStencilObject.H>


Detailed Description

+ Inheritance diagram for centredCECCellToFaceStencilObject:
+ Collaboration diagram for centredCECCellToFaceStencilObject:

List of all members.

Public Member Functions

 TypeName ("centredCECCellToFaceStencil")
 centredCECCellToFaceStencilObject (const fvMesh &mesh)
 Construct from uncompacted face stencil.
virtual ~centredCECCellToFaceStencilObject ()
- Public Member Functions inherited from MeshObject< fvMesh, centredCECCellToFaceStencilObject >
 MeshObject (const fvMesh &mesh)
virtual ~MeshObject ()
const fvMeshmesh () const
virtual bool writeData (Foam::Ostream &) const
 Pure virtual writaData function.
- 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 readData (Istream &)
 Virtual readData function.
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 extendedCentredCellToFaceStencil
 extendedCentredCellToFaceStencil (const cellToFaceStencil &)
 Construct from uncompacted face stencil.
const mapDistributemap () const
 Return reference to the parallel distribution map.
const labelListListstencil () const
 Return reference to the stencil.
void compact ()
 After removing elements from the stencil adapt the schedule (map).
template<class T >
void collectData (const GeometricField< T, fvPatchField, volMesh > &fld, List< List< T > > &stencilFld) const
 Use map to get the data into stencil order.
template<class Type >
tmp< GeometricField< Type,
fvsPatchField, surfaceMesh > > 
weightedSum (const GeometricField< Type, fvPatchField, volMesh > &fld, const List< List< scalar > > &stencilWeights) const
 Sum vol field contributions to create face values.
- Public Member Functions inherited from extendedCellToFaceStencil
 ClassName ("extendedCellToFaceStencil")
 extendedCellToFaceStencil (const polyMesh &)
 Construct from mesh.
template<class Type >
void collectData (const mapDistribute &map, const labelListList &stencil, const GeometricField< Type, fvPatchField, volMesh > &fld, List< List< Type > > &stencilFld)

Additional Inherited Members

- Static Public Member Functions inherited from MeshObject< fvMesh, centredCECCellToFaceStencilObject >
static const
centredCECCellToFaceStencilObject
New (const fvMesh &mesh)
static const
centredCECCellToFaceStencilObject
New (const fvMesh &mesh, const Data1 &d)
static const
centredCECCellToFaceStencilObject
New (const fvMesh &mesh, const Data1 &, const Data2 &)
static const
centredCECCellToFaceStencilObject
New (const fvMesh &mesh, const Data1 &, const Data2 &, const Data3 &)
static const
centredCECCellToFaceStencilObject
New (const fvMesh &mesh, const Data1 &, const Data2 &, const Data3 &, const Data4 &)
static bool Delete (const fvMesh &mesh)
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry.
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry.
- Static Public Member Functions inherited from IOobject
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components.
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner.
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider.
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider.
- Protected Attributes inherited from MeshObject< fvMesh, centredCECCellToFaceStencilObject >
const fvMeshmesh_

Constructor & Destructor Documentation

virtual ~centredCECCellToFaceStencilObject ( )
inlinevirtual

Definition at line 81 of file centredCECCellToFaceStencilObject.H.


Member Function Documentation

TypeName ( "centredCECCellToFaceStencil"  )

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