SubDimensionedField< Type, GeoMesh > Class Template Reference

SubDimensionedField is a DimensionedField obtained as a section of another DimensionedField. More...

#include <OpenFOAM/SubDimensionedField.H>

---

Detailed Description

template<class Type, class GeoMesh>
class Foam::SubDimensionedField< Type, GeoMesh >

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.

Source files

• src/OpenFOAM/fields/DimensionedFields/DimensionedField/SubDimensionedField.H
• src/OpenFOAM/fields/DimensionedFields/DimensionedField/SubDimensionedFieldI.H

Definition at line 56 of file SubDimensionedField.H.

Inheritance diagram for SubDimensionedField< Type, GeoMesh >:

Collaboration diagram for SubDimensionedField< Type, GeoMesh >:

List of all members.

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>&.
Static Public Member Functions
static const SubDimensionedField< Type, GeoMesh > &	null ()
	Return a null SubDimensionedField.

---

Member Typedef Documentation

typedef GeoMesh::Mesh Mesh

Definition at line 66 of file SubDimensionedField.H.

typedef Field<Type>::cmptType cmptType

Component type.

Reimplemented from SubField< Type >.

Definition at line 67 of file SubDimensionedField.H.

---

Constructor & Destructor Documentation

SubDimensionedField

(

const SubField< Type > &

slist  )

[inline]

Construct from a SubField.

Definition at line 35 of file SubDimensionedFieldI.H.

SubDimensionedField	(	const UList< Type > &	list,
		const label	subSize
	)		[inline]

Construct from a UList and size.

Definition at line 44 of file SubDimensionedFieldI.H.

SubDimensionedField	(	const UList< Type > &	list,
		const label	subSize,
		const label	startIndex
	)		[inline]

Construct from a UList start and end indices.

Definition at line 55 of file SubDimensionedFieldI.H.

SubDimensionedField

(

const SubDimensionedField< cmptType, GeoMesh > &

sfield  )

[inline]

Construct as copy.

---

Member Function Documentation

const SubDimensionedField< Type, GeoMesh > & null

(

)

[inline, static]

Return a null SubDimensionedField.

Reimplemented from SubField< Type >.

Definition at line 81 of file SubDimensionedFieldI.H.

tmp< Field< typename SubDimensionedField< Type, GeoMesh >::cmptType > > component

(

const direction

d  )

const [inline]

Return a component field of the field.

Reimplemented from SubField< Type >.

Definition at line 90 of file SubDimensionedFieldI.H.

tmp< DimensionedField< Type, GeoMesh > > T

(

)

const [inline]

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

Reimplemented from SubField< Type >.

Definition at line 103 of file SubDimensionedFieldI.H.

void operator=

(

const SubDimensionedField< Type, GeoMesh > &

rhs  )

[inline]

Assignment.

Definition at line 116 of file SubDimensionedFieldI.H.

References SubField< Type >::operator=().

operator const DimensionedField< Type, GeoMesh > &

(

)

const [inline]

Allow cast to a const DimensionedField<Type, GeoMesh>&.

Definition at line 128 of file SubDimensionedFieldI.H.

---

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

• src/OpenFOAM/fields/DimensionedFields/DimensionedField/SubDimensionedField.H
• src/OpenFOAM/fields/DimensionedFields/DimensionedField/SubDimensionedFieldI.H