Public Types | Public Member Functions | Static Public Member Functions | Friends
FieldField Class Reference

Generic field type. More...

Inheritance diagram for FieldField:
Inheritance graph
[legend]

Public Types

typedef pTraits< Type >::cmptType cmptType
 Component type. More...
 

Public Member Functions

 FieldField ()
 Construct null. More...
 
 FieldField (const label)
 Construct given size. More...
 
 FieldField (const word &, const FieldField< Field, Type > &)
 Construct using the Field sizes from the given FieldField. More...
 
 FieldField (const FieldField< Field, Type > &)
 Construct as copy. More...
 
 FieldField (FieldField< Field, Type > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 FieldField (const PtrList< Field< Type > > &)
 Construct as copy of a PtrList<Field, Type> More...
 
 FieldField (const tmp< FieldField< Field, Type > > &)
 Construct as copy of tmp<FieldField> More...
 
 FieldField (Istream &)
 Construct from Istream. More...
 
tmp< FieldField< Field, Type > > clone () const
 Clone. More...
 
void negate ()
 Negate this field. More...
 
tmp< FieldField< Field, cmptType > > component (const direction) const
 Return a component field of the field. More...
 
void replace (const direction, const FieldField< Field, cmptType > &)
 Replace a component field of the field. More...
 
void replace (const direction, const cmptType &)
 Replace a component field of the field. More...
 
tmp< FieldField< Field, Type > > T () const
 Return the field transpose (only defined for second rank tensors) More...
 
void operator= (const FieldField< Field, Type > &)
 
void operator= (const tmp< FieldField< Field, Type > > &)
 
void operator= (const Type &)
 
void operator+= (const FieldField< Field, Type > &)
 
void operator+= (const tmp< FieldField< Field, Type > > &)
 
void operator-= (const FieldField< Field, Type > &)
 
void operator-= (const tmp< FieldField< Field, Type > > &)
 
void operator*= (const FieldField< Field, scalar > &)
 
void operator*= (const tmp< FieldField< Field, scalar > > &)
 
void operator/= (const FieldField< Field, scalar > &)
 
void operator/= (const tmp< FieldField< Field, scalar > > &)
 
void operator+= (const Type &)
 
void operator-= (const Type &)
 
void operator*= (const scalar &)
 
void operator/= (const scalar &)
 

Static Public Member Functions

template<class Type2 >
static tmp< FieldField< Field, Type > > NewCalculatedType (const FieldField< Field, Type2 > &ff)
 Return a pointer to a new calculatedFvPatchFieldField created on. More...
 

Friends

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

Detailed Description

Generic field type.

Source files

Definition at line 51 of file FieldField.H.

Member Typedef Documentation

◆ cmptType

typedef pTraits<Type>::cmptType cmptType

Component type.

Definition at line 82 of file FieldField.H.

Constructor & Destructor Documentation

◆ FieldField() [1/8]

Construct null.

Used for temporary fields which are initialised after construction

Definition at line 108 of file FieldField.C.

◆ FieldField() [2/8]

FieldField ( const  label)
explicit

Construct given size.

Used for temporary fields which are initialised after construction

◆ FieldField() [3/8]

FieldField ( const word ,
const FieldField< Field, Type > &   
)

Construct using the Field sizes from the given FieldField.

and the given Field type. Used for temporary fields which are initialised after construction

◆ FieldField() [4/8]

FieldField ( const FieldField< Field, Type > &  )

Construct as copy.

◆ FieldField() [5/8]

FieldField ( FieldField< Field, Type > &  ,
bool  reUse 
)

Construct as copy or re-use as specified.

◆ FieldField() [6/8]

FieldField ( const PtrList< Field< Type > > &  )

Construct as copy of a PtrList<Field, Type>

◆ FieldField() [7/8]

FieldField ( const tmp< FieldField< Field, Type > > &  )

Construct as copy of tmp<FieldField>

◆ FieldField() [8/8]

Construct from Istream.

Member Function Documentation

◆ clone()

tmp< FieldField< Field, Type > > clone ( ) const

Clone.

Definition at line 184 of file FieldField.C.

◆ NewCalculatedType()

tmp< FieldField< Field, Type > > NewCalculatedType ( const FieldField< Field, Type2 > &  ff)
static

◆ negate()

void negate ( )

Negate this field.

Definition at line 214 of file FieldField.C.

Referenced by GaussSeidelSmoother::smooth(), symGaussSeidelSmoother::smooth(), and nonBlockingGaussSeidelSmoother::smooth().

Here is the caller graph for this function:

◆ component()

tmp< FieldField< Field, typename FieldField< Field, Type >::cmptType > > component ( const direction  d) const

Return a component field of the field.

Definition at line 226 of file FieldField.C.

◆ replace() [1/2]

void replace ( const  direction,
const FieldField< Field, cmptType > &   
)

Replace a component field of the field.

◆ replace() [2/2]

void replace ( const  direction,
const cmptType  
)

Replace a component field of the field.

◆ T()

tmp< FieldField< Field, Type > > T ( ) const

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

Definition at line 271 of file FieldField.C.

◆ operator=() [1/3]

void operator= ( const FieldField< Field, Type > &  )

◆ operator=() [2/3]

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

◆ operator=() [3/3]

void operator= ( const Type &  )

◆ operator+=() [1/3]

void operator+= ( const FieldField< Field, Type > &  )

◆ operator+=() [2/3]

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

◆ operator-=() [1/3]

void operator-= ( const FieldField< Field, Type > &  )

◆ operator-=() [2/3]

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

◆ operator*=() [1/3]

void operator*= ( const FieldField< Field, scalar > &  )

◆ operator*=() [2/3]

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

◆ operator/=() [1/3]

void operator/= ( const FieldField< Field, scalar > &  )

◆ operator/=() [2/3]

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

◆ operator+=() [3/3]

void operator+= ( const Type &  )

◆ operator-=() [3/3]

void operator-= ( const Type &  )

◆ operator*=() [3/3]

void operator*= ( const scalar &  )

◆ operator/=() [3/3]

void operator/= ( const scalar &  )

Friends And Related Function Documentation

◆ operator [1/2]

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

◆ operator [2/2]

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

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