SubDimensionedField is a DimensionedField obtained as a section of another DimensionedField. More...
#include <OpenFOAM/SubDimensionedField.H>
SubDimensionedField is a DimensionedField obtained as a section of another DimensionedField.
Thus it is itself unallocated so that no storage is allocated or deallocated during its use. To achieve this behaviour, SubDimensionedField is derived from SubField rather than Field.
Definition at line 56 of file SubDimensionedField.H.
Public Types | |
typedef GeoMesh::Mesh | Mesh |
typedef Field< Type >::cmptType | cmptType |
Component type. | |
![]() |
Public Member Functions | |
SubDimensionedField (const SubField< Type > &slist) | |
Construct from a SubField. | |
SubDimensionedField (const UList< Type > &list, const label subSize) | |
Construct from a UList and size. | |
SubDimensionedField (const UList< Type > &list, const label subSize, const label startIndex) | |
Construct from a UList start and end indices. | |
SubDimensionedField (const SubDimensionedField< cmptType, GeoMesh > &sfield) | |
Construct as copy. | |
tmp< DimensionedField < cmptType, GeoMesh > > | component (const direction) const |
Return a component field of the field. | |
tmp< DimensionedField< Type, GeoMesh > > | T () const |
Return the field transpose (only defined for second rank tensors) | |
void | operator= (const SubDimensionedField< Type, GeoMesh > &) |
Assignment. | |
operator const DimensionedField< Type, GeoMesh > & () const | |
Allow cast to a const DimensionedField<Type, GeoMesh>&. | |
![]() | |
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. | |
Istream & | readStream (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 | writeData (Ostream &) const =0 |
Pure virtual writaData function. | |
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 &) |
![]() | |
TypeName ("IOobject") | |
Runtime type information. | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, 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 ®istry, 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 ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
Construct from path, registry, io options. | |
Foam::autoPtr< IOobject > | clone () const |
Clone. | |
virtual | ~IOobject () |
const Time & | time () const |
Return time. | |
const objectRegistry & | db () const |
Return the local objectRegistry. | |
const word & | name () const |
Return name. | |
const word & | headerClassName () const |
Return name of the class name read from header. | |
string & | note () |
Return non-constant access to the optional note. | |
const string & | note () const |
Return the optional note. | |
bool | registerObject () const |
Register object created from this IOobject with registry if true. | |
readOption | readOpt () const |
readOption & | readOpt () |
writeOption | writeOpt () const |
writeOption & | writeOpt () |
const fileName & | rootPath () const |
const fileName & | caseName () const |
const fileName & | instance () const |
fileName & | instance () |
const fileName & | local () 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< IOobject > | info () const |
Return info proxy. | |
![]() | |
SubField (const SubList< Type > &) | |
Construct from a SubList. | |
SubField (const UList< Type > &) | |
Construct from a UList<Type>, using the entire size. | |
SubField (const UList< Type > &list, const label subSize) | |
Construct from a UList<Type> with a given size. | |
SubField (const UList< Type > &list, const label subSize, const label startIndex) | |
Construct from a UList<Type> with a given size and start index. | |
SubField (const SubField< Type > &) | |
Construct as copy. | |
void | operator= (const SubField< Type > &) |
Assignment via UList operator. Takes linear time. | |
operator const Field< Type > & () const | |
Allow cast to a const Field<Type>&. | |
![]() | |
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. | |
![]() | |
SubList (const UList< Type > &list, const label subSize) | |
Construct from UList and sub-list size. | |
SubList (const UList< Type > &list, const label subSize, const label startIndex) | |
Construct from UList, sub-list size and start index. | |
operator const Foam::List< Type > & () const | |
Allow cast to a const List<T>&. | |
void | operator= (const Type &) |
Assignment of all entries to the given value. | |
![]() | |
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 | writeEntry (const word &keyword, Ostream &) const |
Write the UList as a dictionary entry with keyword. | |
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. | |
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 | size () const |
Return the number of elements in 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. |
Static Public Member Functions | |
static const SubDimensionedField< Type, GeoMesh > & | null () |
Return a null SubDimensionedField. | |
![]() | |
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 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. |
Additional Inherited Members | |
![]() | |
static int | fileModificationSkew |
typedef GeoMesh::Mesh Mesh |
Definition at line 66 of file SubDimensionedField.H.
Component type.
Reimplemented from SubField< Type >.
Definition at line 67 of file SubDimensionedField.H.
|
inline |
Construct from a SubField.
Definition at line 35 of file SubDimensionedFieldI.H.
|
inline |
Construct from a UList and size.
Definition at line 44 of file SubDimensionedFieldI.H.
|
inline |
Construct from a UList start and end indices.
Definition at line 55 of file SubDimensionedFieldI.H.
|
inline |
Construct as copy.
|
inlinestatic |
Return a null SubDimensionedField.
Reimplemented from SubField< Type >.
Definition at line 81 of file SubDimensionedFieldI.H.
|
inline |
Return a component field of the field.
Reimplemented from SubField< Type >.
Definition at line 90 of file SubDimensionedFieldI.H.
|
inline |
Return the field transpose (only defined for second rank tensors)
Reimplemented from SubField< Type >.
Definition at line 103 of file SubDimensionedFieldI.H.
|
inline |
Assignment.
Definition at line 116 of file SubDimensionedFieldI.H.
References SubField< Type >::operator=().
|
inline |
Allow cast to a const DimensionedField<Type, GeoMesh>&.
Definition at line 128 of file SubDimensionedFieldI.H.