FreeFOAM The Cross-Platform CFD Toolkit
SlicedGeometricField< Type, PatchField, SlicedPatchField, GeoMesh >::DimensionedInternalField Class Reference

The internalField of a SlicedGeometricField. More...

#include <src/OpenFOAM/fields/GeometricFields/SlicedGeometricField/SlicedGeometricField.H>


Detailed Description

template<class Type, template< class > class PatchField, template< class > class SlicedPatchField, class GeoMesh>
class Foam::SlicedGeometricField< Type, PatchField, SlicedPatchField, GeoMesh >::DimensionedInternalField

The internalField of a SlicedGeometricField.

Definition at line 185 of file SlicedGeometricField.H.

+ Inheritance diagram for SlicedGeometricField< Type, PatchField, SlicedPatchField, GeoMesh >::DimensionedInternalField:
+ Collaboration diagram for SlicedGeometricField< Type, PatchField, SlicedPatchField, GeoMesh >::DimensionedInternalField:

List of all members.

Public Member Functions

 DimensionedInternalField (const IOobject &, const Mesh &, const dimensionSet &, const Field< Type > &iField)
 Construct from components and field to slice.
 ~DimensionedInternalField ()
- Public Member Functions inherited from DimensionedField< Type, GeoMesh >
 TypeName ("DimensionedField")
 Runtime type information.
 DimensionedField (const IOobject &, const Mesh &mesh, const dimensionSet &, const Field< Type > &)
 Construct from components.
 DimensionedField (const IOobject &, const Mesh &mesh, const dimensionSet &)
 Construct from components.
 DimensionedField (const IOobject &, const Mesh &mesh, const dimensioned< Type > &)
 Construct from components.
 DimensionedField (const IOobject &, const Mesh &mesh, const word &fieldDictEntry="value")
 Construct from Istream.
void readField (const dictionary &fieldDict, const word &fieldDictEntry="value")
 DimensionedField (const DimensionedField< Type, GeoMesh > &)
 Construct as copy.
 DimensionedField (DimensionedField< Type, GeoMesh > &, bool reUse)
 Construct as copy or re-use as specified.
 DimensionedField (const Xfer< DimensionedField< Type, GeoMesh > > &)
 Construct by transferring the DimensionedField.
 DimensionedField (const IOobject &, const DimensionedField< Type, GeoMesh > &)
 Construct as copy of tmp<DimensionedField> deleting argument.
 DimensionedField (const word &newName, const DimensionedField< Type, GeoMesh > &)
 Construct as copy resetting name.
 DimensionedField (const word &newName, DimensionedField< Type, GeoMesh > &, bool reUse)
 Construct as copy resetting name and re-use as specified.
 DimensionedField (const word &newName, const Xfer< DimensionedField< Type, GeoMesh > > &)
 Construct by transferring the DimensionedField with a new name.
tmp< DimensionedField< Type,
GeoMesh > > 
clone () const
 Construct as copy resetting name.
virtual ~DimensionedField ()
 Destructor.
const Meshmesh () const
 Return mesh.
const dimensionSetdimensions () const
 Return dimensions.
dimensionSetdimensions ()
 Return non-const access to dimensions.
const Field< Type > & field () const
Field< Type > & field ()
tmp< DimensionedField
< cmptType, GeoMesh > > 
component (const direction) const
 Return a component field of the field.
void replace (const direction, const DimensionedField< cmptType, GeoMesh > &)
 Replace a component field of the field.
void replace (const direction, const tmp< DimensionedField< cmptType, GeoMesh > > &)
 Replace a component field of the field.
tmp< DimensionedField< Type,
GeoMesh > > 
T () const
 Return the field transpose (only defined for second rank tensors)
dimensioned< Type > average () const
 Calculate and return arithmetic average.
dimensioned< Type > weightedAverage (const DimensionedField< scalar, GeoMesh > &) const
 Calculate and return weighted average.
dimensioned< Type > weightedAverage (const tmp< DimensionedField< scalar, GeoMesh > > &) const
 Calculate and return weighted average.
bool writeData (Ostream &, const word &fieldDictEntry) const
bool writeData (Ostream &) const
 Pure virtual writaData function.
void operator= (const DimensionedField< Type, GeoMesh > &)
void operator= (const tmp< DimensionedField< Type, GeoMesh > > &)
void operator= (const dimensioned< Type > &)
void operator+= (const DimensionedField< Type, GeoMesh > &)
void operator+= (const tmp< DimensionedField< Type, GeoMesh > > &)
void operator-= (const DimensionedField< Type, GeoMesh > &)
void operator-= (const tmp< DimensionedField< Type, GeoMesh > > &)
void operator*= (const DimensionedField< scalar, GeoMesh > &)
void operator*= (const tmp< DimensionedField< scalar, GeoMesh > > &)
void operator/= (const DimensionedField< scalar, GeoMesh > &)
void operator/= (const tmp< DimensionedField< scalar, GeoMesh > > &)
void operator+= (const dimensioned< Type > &)
void operator-= (const dimensioned< Type > &)
void operator*= (const dimensioned< scalar > &)
void operator/= (const dimensioned< scalar > &)
- 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.
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 Field< Type >
 Field ()
 Construct null.
 Field (const label)
 Construct given size.
 Field (const label, const Type &)
 Construct given size and initial value.
 Field (const UList< Type > &)
 Construct as copy of a UList<Type>
 Field (const Xfer< List< Type > > &)
 Construct by transferring the List contents.
 Field (const UList< Type > &mapF, const unallocLabelList &mapAddressing)
 Construct by 1 to 1 mapping from the given field.
 Field (const tmp< Field< Type > > &tmapF, const unallocLabelList &mapAddressing)
 Construct by 1 to 1 mapping from the given tmp field.
 Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given field.
 Field (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given tmp field.
 Field (const UList< Type > &mapF, const FieldMapper &map)
 Construct by mapping from the given field.
 Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map)
 Construct by mapping from the given tmp field.
 Field (const Field< Type > &)
 Construct as copy.
 Field (Field< Type > &, bool reUse)
 Construct as copy or re-use as specified.
 Field (const Xfer< Field< Type > > &)
 Construct by transferring the Field contents.
 Field (const typename Field< Type >::subField &)
 Construct as copy of subField.
 Field (Istream &)
 Construct as copy of tmp<Field>
 Field (const word &keyword, const dictionary &dict, const label size)
 Construct from a dictionary entry.
void map (const UList< Type > &mapF, const unallocLabelList &mapAddressing)
 1 to 1 map from the given field
void map (const tmp< Field< Type > > &tmapF, const unallocLabelList &mapAddressing)
 1 to 1 map from the given tmp field
void map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given field.
void map (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given tmp field.
void map (const UList< Type > &mapF, const FieldMapper &map)
 Map from the given field.
void map (const tmp< Field< Type > > &tmapF, const FieldMapper &map)
 Map from the given tmp field.
void autoMap (const FieldMapper &map)
 Map from self.
void rmap (const UList< Type > &mapF, const unallocLabelList &mapAddressing)
 1 to 1 reverse-map from the given field
void rmap (const tmp< Field< Type > > &tmapF, const unallocLabelList &mapAddressing)
 1 to 1 reverse-map from the given tmp field
void rmap (const UList< Type > &mapF, const unallocLabelList &mapAddressing, const scalarList &weights)
 Interpolative reverse map from the given field.
void rmap (const tmp< Field< Type > > &tmapF, const unallocLabelList &mapAddressing, const scalarList &weights)
 Interpolative reverse map from the given tmp field.
void negate ()
 Negate this field.
void replace (const direction, const UList< cmptType > &)
 Replace a component field of the field.
void replace (const direction, const tmp< Field< cmptType > > &)
 Replace a component field of the field.
void replace (const direction, const cmptType &)
 Replace a component field of the field.
void writeEntry (const word &keyword, Ostream &os) const
 Write the field as a dictionary entry.
void operator= (const Field< Type > &)
void operator= (const UList< Type > &)
 Assignment from UList operator. Takes linear time.
void operator= (const SubField< Type > &)
void operator= (const tmp< Field< Type > > &)
void operator= (const Type &)
 Assignment of all entries to the given value.
template<class Form , class Cmpt , int nCmpt>
void operator= (const VectorSpace< Form, Cmpt, nCmpt > &)
void operator+= (const UList< Type > &)
void operator+= (const tmp< Field< Type > > &)
void operator-= (const UList< Type > &)
void operator-= (const tmp< Field< Type > > &)
void operator*= (const UList< scalar > &)
void operator*= (const tmp< Field< scalar > > &)
void operator/= (const UList< scalar > &)
void operator/= (const tmp< Field< scalar > > &)
void operator+= (const Type &)
void operator-= (const Type &)
void operator*= (const scalar &)
void operator/= (const scalar &)
template<class Type>
void operator= (const tmp< Field > &rhs)
- Public Member Functions inherited from refCount
 refCount ()
 Construct null with zero count.
int count () const
 Return the reference count.
bool okToDelete () const
 Return true if the reference count is zero.
void resetRefCount ()
 Reset the reference count to zero.
void operator++ ()
 Increment the reference count.
void operator++ (int)
 Increment the reference count.
void operator-- ()
 Decrement the reference count.
void operator-- (int)
 Decrement the reference count.
- Public Member Functions inherited from List< Type >
label size () const
 Return the number of elements in the UList.
 List ()
 Null constructor.
 List (const label)
 Construct with given size.
 List (const label, const Type &)
 Construct with given size and value for all elements.
 List (const List< Type > &)
 Copy constructor.
 List (const Xfer< List< Type > > &)
 Construct by transferring the parameter contents.
 List (List< Type > &, bool reUse)
 Construct as copy or re-use as specified.
 List (const UList< Type > &, const unallocLabelList &mapAddressing)
 Construct as subset.
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators.
 List (const FixedList< Type, Size > &)
 Construct as copy of FixedList<T, Size>
 List (const PtrList< Type > &)
 Construct as copy of PtrList<T>
 List (const SLList< Type > &)
 Construct as copy of SLList<T>
 List (const IndirectList< Type > &)
 Construct as copy of IndirectList<T>
 List (const UIndirectList< Type > &)
 Construct as copy of UIndirectList<T>
 List (const BiIndirectList< Type > &)
 Construct as copy of BiIndirectList<T>
 List (Istream &)
 Construct from Istream.
 ~List ()
void resize (const label)
 Reset size of List.
void resize (const label, const Type &)
 Reset size of List and value for new elements.
void setSize (const label)
 Reset size of List.
void setSize (const label, const Type &)
 Reset size of List and value for new elements.
void clear ()
 Clear the list, i.e. set size to zero.
void append (const UList< Type > &)
 Append a List at the end of this list.
void append (const UIndirectList< Type > &)
 Append a UIndirectList at the end of this list.
void transfer (List< Type > &)
 Transfer the contents of the argument List into this list.
void transfer (DynamicList< Type, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list.
void transfer (SortableList< Type > &)
 Transfer the contents of the argument List into this list.
Xfer< List< Type > > xfer ()
 Transfer contents to the Xfer container.
Type & newElmt (const label)
 Return subscript-checked element of UList.
void operator= (const List< Type > &)
 Assignment operator. Takes linear time.
void operator= (const SLList< Type > &)
 Assignment from SLList operator. Takes linear time.
void operator= (const IndirectList< Type > &)
 Assignment from IndirectList operator. Takes linear time.
void operator= (const UIndirectList< Type > &)
 Assignment from UIndirectList operator. Takes linear time.
void operator= (const BiIndirectList< Type > &)
 Assignment from BiIndirectList operator. Takes linear time.
- Public Member Functions inherited from UList< Type >
 UList ()
 Null constructor.
 UList (Type *__restrict__ v, label size)
 Construct from components.
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index.
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index.
label byteSize () const
 Return the binary size in number of characters of the UList.
const Type * cdata () const
 Return a const pointer to the first data element,.
Type * data ()
 Return a pointer to the first data element,.
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1).
void checkSize (const label size) const
 Check size is within valid range (0 ... size).
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1).
void writeEntry (Ostream &) const
 Write the UList as a dictionary entry.
void assign (const UList< Type > &)
 Assign elements to those from UList.
Type & operator[] (const label)
 Return element of UList.
const Type & operator[] (const label) const
 Return element of constant UList.
 operator const Foam::List< Type > & () const
 Allow cast to a const List<T>&.
iterator begin ()
 Return an iterator to begin traversing the UList.
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList.
iterator end ()
 Return an iterator to end traversing the UList.
const_iterator end () const
 Return const_iterator to end traversing the constant UList.
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant UList.
const_iterator cend () const
 Return const_iterator to end traversing the constant UList.
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList.
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing the UList.
label max_size () const
 Return size of the largest possible UList.
bool empty () const
 Return true if the UList is empty (ie, size() is zero).
void swap (UList< Type > &)
 Swap two ULists of the same type in constant time.
bool operator== (const UList< Type > &) const
 Equality operation on ULists of the same type.
bool operator!= (const UList< Type > &) const
 The opposite of the equality operation. Takes linear time.
bool operator< (const UList< Type > &) const
 Compare two ULists lexicographically. Takes linear time.
bool operator> (const UList< Type > &) const
 Compare two ULists lexicographically. Takes linear time.
bool operator<= (const UList< Type > &) const
 Return true if !(a > b). Takes linear time.
bool operator>= (const UList< Type > &) const
 Return true if !(a < b). Takes linear time.

Additional Inherited Members

- Public Types inherited from DimensionedField< Type, GeoMesh >
typedef GeoMesh::Mesh Mesh
typedef Field< Type >::cmptType cmptType
 Component type.
- Public Types inherited from Field< Type >
typedef SubField< Type > subField
 Declare type of subField.
- Public Types inherited from List< Type >
typedef SubList< Type > subList
 Declare type of subList.
- Public Types inherited from UList< Type >
typedef Type value_type
 Type of values the UList contains.
typedef Type & reference
 Type that can be used for storing into.
typedef const Type & const_reference
 Type that can be used for storing into.
typedef label difference_type
 The type that can represent the difference between any two.
typedef label size_type
 The type that can represent the size of a UList.
typedef Type * iterator
 Random access iterator for traversing UList.
typedef const Type * const_iterator
 Random access iterator for traversing UList.
typedef Type * reverse_iterator
 Reverse iterator for reverse traversal of UList.
typedef const Type * const_reverse_iterator
 Reverse iterator for reverse traversal of constant UList.
- Static Public Member Functions inherited from DimensionedField< Type, GeoMesh >
static const DimensionedField
< Type, GeoMesh > & 
null ()
 Return a null DimensionedField.
- 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.
- Static Public Member Functions inherited from Field< Type >
template<class Type2 >
static tmp< Field< Type > > NewCalculatedType (const Field< Type2 > &f)
 Return a pointer to a new calculatedFvPatchFieldField created on.

Constructor & Destructor Documentation

DimensionedInternalField ( const IOobject io,
const Mesh mesh,
const dimensionSet ds,
const Field< Type > &  iField 
)

Construct from components and field to slice.

Definition at line 172 of file SlicedGeometricField.C.

Definition at line 352 of file SlicedGeometricField.C.


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