Field< Type > Class Template Reference

Pre-declare SubField and related Field type. More...

Inheritance diagram for Field< Type >:
Collaboration diagram for Field< Type >:

Public Types

typedef pTraits< Type >::cmptType cmptType
 Component type. More...
 
typedef SubField< Type > subField
 Declare type of subField. More...
 
- Public Types inherited from List< Type >
typedef SubList< Type > subList
 Declare type of subList. More...
 
- Public Types inherited from UList< Type >
typedef Type value_type
 Type of values the UList contains. More...
 
typedef Type & reference
 Type that can be used for storing into. More...
 
typedef const Type & const_reference
 Type that can be used for storing into. More...
 
typedef label difference_type
 The type that can represent the difference between any two. More...
 
typedef label size_type
 The type that can represent the size of a UList. More...
 
typedef Type * iterator
 Random access iterator for traversing UList. More...
 
typedef const Type * const_iterator
 Random access iterator for traversing UList. More...
 
typedef std::reverse_iterator< iteratorreverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList. More...
 

Public Member Functions

 Field ()
 Construct null. More...
 
 Field (const label)
 Construct given size. More...
 
 Field (const label, const Type &)
 Construct given size and initial value. More...
 
 Field (const label, const zero)
 Construct given size and initialed to zero. More...
 
 Field (const UList< Type > &)
 Copy constructor of a UList<Type> More...
 
 Field (List< Type > &&)
 Mover constructor transferring the List contents. More...
 
 Field (const UIndirectList< Type > &)
 Copy constructor of a UIndirectList<Type> More...
 
 Field (const Field< Type > &)
 Copy constructor. More...
 
 Field (Field< Type > &, bool reuse)
 Copy constructor or re-use as specified. More...
 
 Field (Field< Type > &&)
 Move constructor transferring the Field contents. More...
 
 Field (const tmp< Field< Type >> &)
 Copy constructor of tmp<Field> More...
 
 Field (const UList< Type > &mapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given field. More...
 
 Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given tmp field. More...
 
 Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given field. More...
 
 Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given tmp field. More...
 
 Field (Istream &)
 Construct from Istream. More...
 
 Field (const word &keyword, const dictionary &, const label size)
 Construct from a dictionary entry. More...
 
tmp< Field< Type > > clone () const
 Clone. More...
 
void map (const UList< Type > &mapF, const labelUList &mapAddressing)
 1 to 1 map from the given field More...
 
void map (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
 1 to 1 map from the given tmp field More...
 
void map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given field. More...
 
void map (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given tmp field. More...
 
void rmap (const UList< Type > &mapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given field More...
 
void rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given tmp field More...
 
void rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given field. More...
 
void rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given tmp field. More...
 
void reset (const Field< Type > &)
 Reset the field values to the given field. More...
 
void negate ()
 Negate this field. More...
 
tmp< Field< cmptType > > component (const direction) const
 Return a component field of the field. More...
 
void replace (const direction, const UList< cmptType > &)
 Replace a component field of the field. More...
 
void replace (const direction, const tmp< Field< cmptType >> &)
 Replace a component field of the field. More...
 
void replace (const direction, const cmptType &)
 Replace a component field of the field. More...
 
template<class VSForm >
VSForm block (const label start) const
 
tmp< Field< Type > > T () const
 Return the field transpose (only defined for second rank tensors) More...
 
void operator= (const Field< Type > &)
 
void operator= (Field< Type > &&)
 
void operator= (const UList< Type > &)
 
void operator= (List< Type > &&)
 
void operator= (const SubField< Type > &)
 
void operator= (const tmp< Field< Type >> &)
 
void operator= (const Type &)
 
void operator= (const zero)
 
template<class Form , class Cmpt , direction 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
int count () const
 Return the current reference count. More...
 
bool unique () const
 Return true if the reference count is zero. More...
 
void operator++ ()
 Increment the reference count. More...
 
void operator++ (int)
 Increment the reference count. More...
 
void operator-- ()
 Decrement the reference count. More...
 
void operator-- (int)
 Decrement the reference count. More...
 
- Public Member Functions inherited from List< Type >
 List ()
 Null constructor. More...
 
 List (const label)
 Construct with given size. More...
 
 List (const label, const Type &)
 Construct with given size and value for all elements. More...
 
 List (const label, const zero)
 Construct with given size initialising all elements to zero. More...
 
 List (const List< Type > &)
 Copy constructor. More...
 
 List (const List< T2 > &)
 Copy constructor from list containing another type. More...
 
 List (List< Type > &&)
 Move constructor. More...
 
 List (List< Type > &, bool reuse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< Type > &, const labelUList &mapAddressing)
 Construct as subset. More...
 
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators. More...
 
 List (const FixedList< Type, Size > &)
 Construct as copy of FixedList<T, Size> More...
 
 List (const PtrList< Type > &)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< Type > &)
 Construct as copy of SLList<T> More...
 
 List (const UIndirectList< Type > &)
 Construct as copy of UIndirectList<T> More...
 
 List (const BiIndirectList< Type > &)
 Construct as copy of BiIndirectList<T> More...
 
 List (std::initializer_list< Type >)
 Construct from an initialiser list. More...
 
 List (Istream &)
 Construct from Istream. More...
 
label size () const
 Return the number of elements in the UList. More...
 
autoPtr< List< Type > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void resize (const label, const Type &)
 Alias for setSize(const label, const T&) More...
 
void setSize (const label)
 Reset size of List. More...
 
void setSize (const label, const Type &)
 Reset size of List and value for new elements. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void append (const Type &)
 Append an element at the end of the list. More...
 
void append (const UList< Type > &)
 Append a List at the end of this list. More...
 
void append (const UIndirectList< Type > &)
 Append a UIndirectList at the end of this list. More...
 
void transfer (List< Type > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (DynamicList< Type, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (SortableList< Type > &)
 Transfer the contents of the argument List into this list. More...
 
Type & newElmt (const label)
 Return subscript-checked element of UList. More...
 
void shallowCopy (const UList< Type > &)=delete
 Disallow implicit shallowCopy. More...
 
void operator= (const UList< Type > &)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< Type > &)
 Assignment operator. Takes linear time. More...
 
void operator= (List< Type > &&)
 Move assignment operator. More...
 
void operator= (const SLList< Type > &)
 Assignment to SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< Type > &)
 Assignment to UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< Type > &)
 Assignment to BiIndirectList operator. Takes linear time. More...
 
void operator= (std::initializer_list< Type >)
 Assignment to an initialiser list. More...
 
void operator= (const Type &)
 Assignment of all entries to the given value. More...
 
void operator= (const zero)
 Assignment of all entries to zero. More...
 
- Public Member Functions inherited from UList< Type >
void operator= (const Type &)
 Assignment of all entries to the given value. More...
 
void operator= (const zero)
 Assignment of all entries to zero. More...
 
 UList ()
 Null constructor. More...
 
 UList (Type *__restrict__ v, label size)
 Construct from components. More...
 
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index. More...
 
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index. More...
 
std::streamsize byteSize () const
 Return the binary size in number of characters of the UList. More...
 
const Type * cdata () const
 Return a const pointer to the first data element,. More...
 
Type * data ()
 Return a pointer to the first data element,. More...
 
Type & first ()
 Return the first element of the list. More...
 
const Type & first () const
 Return first element of the list. More...
 
Type & last ()
 Return the last element of the list. More...
 
const Type & last () const
 Return the last element of the list. More...
 
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1) More...
 
void checkSize (const label size) const
 Check size is within valid range (0 ... size) More...
 
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1) More...
 
void shallowCopy (const UList< Type > &)
 Copy the pointer held by the given UList. More...
 
void deepCopy (const UList< Type > &)
 Copy elements of the given UList. More...
 
Type & operator[] (const label)
 Return element of UList. More...
 
const Type & operator[] (const label) const
 Return element of constant UList. More...
 
const booloperator[] (const label i) const
 
 operator const Foam::List< Type > & () const
 Allow cast to a const List<T>&. More...
 
iterator begin ()
 Return an iterator to begin traversing the UList. More...
 
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList. More...
 
iterator end ()
 Return an iterator to end traversing the UList. More...
 
const_iterator end () const
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator cend () const
 Return const_iterator to end traversing the constant UList. More...
 
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
label size () const
 Return the number of elements in the UList. More...
 
label max_size () const
 Return size of the largest possible UList. More...
 
bool empty () const
 Return true if the UList is empty (ie, size() is zero) More...
 
void swap (UList< Type > &)
 Swap two ULists of the same type in constant time. More...
 
bool operator== (const UList< Type > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< Type > &) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< Type > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< Type > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< Type > &) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< Type > &) const
 Return true if !(a < b). Takes linear time. More...
 

Static Public Member Functions

static const Field< Type > & null ()
 Return a null field. More...
 
template<class Type2 >
static tmp< Field< Type > > NewCalculatedType (const Field< Type2 > &f)
 Return a pointer to a new calculatedFvPatchFieldField created on. More...
 
- Static Public Member Functions inherited from List< Type >
static const List< Type > & null ()
 Return a null List. More...
 
- Static Public Member Functions inherited from UList< Type >
static const UList< Type > & null ()
 Return a null UList. More...
 

Static Public Attributes

static const char *const typeName
 

Friends

Ostreamoperator (Ostream &, const Field< Type > &)
 
Ostreamoperator (Ostream &, const tmp< Field< Type >> &)
 

Additional Inherited Members

- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
- Protected Member Functions inherited from List< Type >
void size (const label)
 Override size to be inconsistent with allocated storage. More...
 

Detailed Description

template<class Type>
class Foam::Field< Type >

Pre-declare SubField and related Field type.

Generic templated field type.

Source files

Definition at line 56 of file Field.H.

Member Typedef Documentation

◆ cmptType

typedef pTraits<Type>::cmptType cmptType

Component type.

Definition at line 97 of file Field.H.

◆ subField

typedef SubField<Type> subField

Declare type of subField.

Definition at line 100 of file Field.H.

Constructor & Destructor Documentation

◆ Field() [1/17]

Field ( )

Construct null.

Used for temporary fields which are initialised after construction

Definition at line 40 of file Field.C.

Referenced by Field< PointType >::Field(), and Field< PointType >::null().

Here is the caller graph for this function:

◆ Field() [2/17]

Field ( const label  size)
explicit

Construct given size.

Used for temporary fields which are initialised after construction

Definition at line 47 of file Field.C.

◆ Field() [3/17]

Field ( const label  size,
const Type &  t 
)

Construct given size and initial value.

Definition at line 54 of file Field.C.

◆ Field() [4/17]

Field ( const label  size,
const zero   
)

Construct given size and initialed to zero.

Definition at line 61 of file Field.C.

◆ Field() [5/17]

Field ( const UList< Type > &  list)
explicit

Copy constructor of a UList<Type>

Definition at line 68 of file Field.C.

◆ Field() [6/17]

Field ( List< Type > &&  f)
explicit

Mover constructor transferring the List contents.

Definition at line 75 of file Field.C.

◆ Field() [7/17]

Field ( const UIndirectList< Type > &  list)
explicit

Copy constructor of a UIndirectList<Type>

Definition at line 82 of file Field.C.

◆ Field() [8/17]

Field ( const Field< Type > &  f)

Copy constructor.

Definition at line 89 of file Field.C.

◆ Field() [9/17]

Field ( Field< Type > &  f,
bool  reuse 
)

Copy constructor or re-use as specified.

Definition at line 97 of file Field.C.

◆ Field() [10/17]

Field ( Field< Type > &&  f)

Move constructor transferring the Field contents.

Definition at line 104 of file Field.C.

◆ Field() [11/17]

Field ( const tmp< Field< Type >> &  tf)

Copy constructor of tmp<Field>

Definition at line 112 of file Field.C.

◆ Field() [12/17]

Field ( const UList< Type > &  mapF,
const labelUList mapAddressing 
)

Construct by 1 to 1 mapping from the given field.

Definition at line 122 of file Field.C.

◆ Field() [13/17]

Field ( const tmp< Field< Type >> &  tmapF,
const labelUList mapAddressing 
)

Construct by 1 to 1 mapping from the given tmp field.

Definition at line 135 of file Field.C.

◆ Field() [14/17]

Field ( const UList< Type > &  mapF,
const labelListList mapAddressing,
const scalarListList weights 
)

Construct by interpolative mapping from the given field.

Definition at line 148 of file Field.C.

◆ Field() [15/17]

Field ( const tmp< Field< Type >> &  tmapF,
const labelListList mapAddressing,
const scalarListList weights 
)

Construct by interpolative mapping from the given tmp field.

Definition at line 162 of file Field.C.

◆ Field() [16/17]

Field ( Istream is)

Construct from Istream.

Definition at line 175 of file Field.C.

◆ Field() [17/17]

Field ( const word keyword,
const dictionary dict,
const label  size 
)

Construct from a dictionary entry.

Definition at line 183 of file Field.C.

Member Function Documentation

◆ null()

static const Field<Type>& null ( )
inlinestatic

Return a null field.

Definition at line 111 of file Field.H.

Referenced by coordSet::pointCoords(), and gnuplotSetWriter::write().

Here is the caller graph for this function:

◆ clone()

Foam::tmp< Foam::Field< Type > > clone ( ) const

Clone.

Definition at line 240 of file Field.C.

Referenced by Field< PointType >::null().

Here is the caller graph for this function:

◆ NewCalculatedType()

static tmp<Field<Type> > NewCalculatedType ( const Field< Type2 > &  f)
inlinestatic

Return a pointer to a new calculatedFvPatchFieldField created on.

freestore without setting patchField values

Definition at line 196 of file Field.H.

◆ map() [1/4]

void map ( const UList< Type > &  mapF,
const labelUList mapAddressing 
)

1 to 1 map from the given field

Definition at line 265 of file Field.C.

Referenced by Field< PointType >::clone(), Field< PointType >::map(), Field< PointType >::NewCalculatedType(), and polyMesh::topoChange().

Here is the caller graph for this function:

◆ map() [2/4]

void map ( const tmp< Field< Type >> &  tmapF,
const labelUList mapAddressing 
)

1 to 1 map from the given tmp field

Definition at line 297 of file Field.C.

◆ map() [3/4]

void map ( const UList< Type > &  mapF,
const labelListList mapAddressing,
const scalarListList weights 
)

Interpolative map from the given field.

Definition at line 309 of file Field.C.

◆ map() [4/4]

void map ( const tmp< Field< Type >> &  tmapF,
const labelListList mapAddressing,
const scalarListList weights 
)

Interpolative map from the given tmp field.

Definition at line 349 of file Field.C.

◆ rmap() [1/4]

◆ rmap() [2/4]

void rmap ( const tmp< Field< Type >> &  tmapF,
const labelUList mapAddressing 
)

1 to 1 reverse-map from the given tmp field

Definition at line 386 of file Field.C.

◆ rmap() [3/4]

void rmap ( const UList< Type > &  mapF,
const labelUList mapAddressing,
const UList< scalar > &  weights 
)

Interpolative reverse map from the given field.

Definition at line 398 of file Field.C.

◆ rmap() [4/4]

void rmap ( const tmp< Field< Type >> &  tmapF,
const labelUList mapAddressing,
const UList< scalar > &  weights 
)

Interpolative reverse map from the given tmp field.

Definition at line 420 of file Field.C.

◆ reset()

void reset ( const Field< Type > &  rhs)

◆ negate()

void negate ( )

Negate this field.

Definition at line 446 of file Field.C.

Referenced by lduMatrix::negate(), and Field< PointType >::NewCalculatedType().

Here is the caller graph for this function:

◆ component()

◆ replace() [1/3]

◆ replace() [2/3]

void replace ( const direction  d,
const tmp< Field< cmptType >> &  tsf 
)

Replace a component field of the field.

Definition at line 479 of file Field.C.

◆ replace() [3/3]

void replace ( const direction  d,
const cmptType c 
)

Replace a component field of the field.

Definition at line 491 of file Field.C.

◆ block()

◆ T()

Foam::tmp< Foam::Field< Type > > T ( ) const

Return the field transpose (only defined for second rank tensors)

Definition at line 515 of file Field.C.

Referenced by Field< PointType >::NewCalculatedType(), linearDamper::restrain(), sphericalAngularDamper::restrain(), and linearAxialAngularSpring::restrain().

Here is the caller graph for this function:

◆ operator=() [1/10]

◆ operator=() [2/10]

void operator= ( Field< Type > &&  rhs)

Definition at line 540 of file Field.C.

◆ operator=() [3/10]

void operator= ( const UList< Type > &  rhs)

Definition at line 561 of file Field.C.

◆ operator=() [4/10]

void operator= ( List< Type > &&  rhs)

Definition at line 568 of file Field.C.

◆ operator=() [5/10]

void operator= ( const SubField< Type > &  rhs)

Definition at line 554 of file Field.C.

◆ operator=() [6/10]

void operator= ( const tmp< Field< Type >> &  )

◆ operator=() [7/10]

void operator= ( const Type &  t)

Definition at line 589 of file Field.C.

◆ operator=() [8/10]

void operator= ( const zero  )

Definition at line 596 of file Field.C.

◆ operator=() [9/10]

void operator= ( const VectorSpace< Form, Cmpt, nCmpt > &  vs)

Definition at line 604 of file Field.C.

◆ operator+=() [1/3]

void operator+= ( const UList< Type > &  f)

Definition at line 631 of file Field.C.

Referenced by Field< PointType >::NewCalculatedType().

Here is the caller graph for this function:

◆ operator+=() [2/3]

void operator+= ( const tmp< Field< Type >> &  tf)

Definition at line 631 of file Field.C.

◆ operator-=() [1/3]

void operator-= ( const UList< Type > &  f)

Definition at line 632 of file Field.C.

Referenced by Field< PointType >::NewCalculatedType().

Here is the caller graph for this function:

◆ operator-=() [2/3]

void operator-= ( const tmp< Field< Type >> &  tf)

Definition at line 632 of file Field.C.

◆ operator*=() [1/3]

void operator*= ( const UList< scalar > &  f)

Definition at line 633 of file Field.C.

Referenced by Field< PointType >::NewCalculatedType().

Here is the caller graph for this function:

◆ operator*=() [2/3]

void operator*= ( const tmp< Field< scalar >> &  tf)

Definition at line 633 of file Field.C.

◆ operator/=() [1/3]

void operator/= ( const UList< scalar > &  f)

Definition at line 634 of file Field.C.

Referenced by Field< PointType >::NewCalculatedType().

Here is the caller graph for this function:

◆ operator/=() [2/3]

void operator/= ( const tmp< Field< scalar >> &  tf)

Definition at line 634 of file Field.C.

◆ operator+=() [3/3]

void operator+= ( const Type &  t)

Definition at line 631 of file Field.C.

◆ operator-=() [3/3]

void operator-= ( const Type &  t)

Definition at line 632 of file Field.C.

◆ operator*=() [3/3]

void operator*= ( const scalar &  t)

Definition at line 633 of file Field.C.

◆ operator/=() [3/3]

void operator/= ( const scalar &  t)

Definition at line 634 of file Field.C.

◆ operator=() [10/10]

void operator= ( const tmp< Field< Type > > &  rhs)

Definition at line 575 of file Field.C.

Friends And Related Function Documentation

◆ operator [1/2]

Ostream& operator ( Ostream ,
const Field< Type > &   
)
friend

◆ operator [2/2]

Ostream& operator ( Ostream ,
const tmp< Field< Type >> &   
)
friend

Member Data Documentation

◆ typeName


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