slicedFvPatchField< Type > Class Template Reference

Specialization of fvPatchField which creates the underlying fvPatchField as a slice of the given complete field. More...

Inheritance diagram for slicedFvPatchField< Type >:

Collaboration diagram for slicedFvPatchField< Type >:

Public Member Functions
	TypeName ("sliced")
	slicedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
	slicedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	slicedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	slicedFvPatchField (const slicedFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	slicedFvPatchField (const slicedFvPatchField< Type > &)
virtual tmp< fvPatchField< Type > >	clone () const
	slicedFvPatchField (const slicedFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
virtual tmp< fvPatchField< Type > >	clone (const DimensionedField< Type, volMesh > &iF) const
virtual	~slicedFvPatchField ()
virtual bool	fixesValue () const
virtual bool	assignable () const
virtual tmp< Field< Type > >	snGrad () const
virtual tmp< Field< Type > >	patchInternalField () const
virtual void	patchInternalField (Field< Type > &) const
virtual tmp< Field< Type > >	patchNeighbourField (const Field< Type > &iField) const
virtual tmp< Field< Type > >	patchNeighbourField () const
virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const
virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const
virtual tmp< Field< Type > >	gradientInternalCoeffs () const
virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
virtual void	write (Ostream &) const
virtual void	operator= (const UList< Type > &)
virtual void	operator= (const fvPatchField< Type > &)
virtual void	operator+= (const fvPatchField< Type > &)
virtual void	operator-= (const fvPatchField< Type > &)
virtual void	operator*= (const fvPatchField< scalar > &)
virtual void	operator/= (const fvPatchField< scalar > &)
virtual void	operator+= (const Field< Type > &)
virtual void	operator-= (const Field< Type > &)
virtual void	operator*= (const Field< scalar > &)
virtual void	operator/= (const Field< scalar > &)
virtual void	operator= (const Type &)
virtual void	operator+= (const Type &)
virtual void	operator-= (const Type &)
virtual void	operator*= (const scalar)
virtual void	operator/= (const scalar)
Public Member Functions inherited from fvPatchField< Type >
	TypeName ("fvPatchField")
	declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF),(p, iF))
	declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m))
	declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict),(p, iF, dict))
	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)
	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	fvPatchField (const fvPatchField< Type > &)
	fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
virtual tmp< fvPatchField< Type > >	clone () const
Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatch &p)
Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &pf)
virtual	~fvPatchField ()=default
bool	useImplicit () const noexcept
bool	useImplicit (bool on) noexcept
virtual bool	fixesValue () const
virtual bool	assignable () const
virtual bool	coupled () const
const objectRegistry &	db () const
const fvPatch &	patch () const
const DimensionedField< Type, volMesh > &	internalField () const
const Field< Type > &	primitiveField () const
const word &	patchType () const
word &	patchType ()
bool	updated () const
bool	manipulatedMatrix () const
virtual void	autoMap (const fvPatchFieldMapper &)
virtual void	rmap (const fvPatchField< Type > &, const labelList &)
virtual tmp< Field< Type > >	snGrad () const
virtual tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const
virtual void	updateCoeffs ()
virtual void	updateWeightedCoeffs (const scalarField &weights)
virtual tmp< Field< Type > >	patchInternalField () const
virtual tmp< Field< Type > >	patchNeighbourField () const
virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< Field< scalar >> &) const
virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
virtual tmp< Field< Type > >	gradientInternalCoeffs () const
virtual tmp< Field< Type > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const
virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
virtual tmp< Field< Type > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
virtual void	manipulateMatrix (fvMatrix< Type > &matrix)
virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp)
void	check (const fvPatchField< Type > &) const
virtual void	operator== (const fvPatchField< Type > &)
virtual void	operator== (const Field< Type > &)
virtual void	operator== (const Type &)

Additional Inherited Members
Public Types inherited from fvPatchField< Type >
typedef fvPatch	Patch
typedef calculatedFvPatchField< Type >	Calculated
Static Public Member Functions inherited from fvPatchField< Type >
static tmp< fvPatchField< Type > >	New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)
static tmp< fvPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)
static tmp< fvPatchField< Type > >	New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
static tmp< fvPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatch &)
static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &)
static const word &	calculatedType ()
Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField

Detailed Description

template<class Type>
class Foam::slicedFvPatchField< Type >

Specialization of fvPatchField which creates the underlying fvPatchField as a slice of the given complete field.

The destructor is wrapped to avoid deallocation of the storage of the complete fields when this is destroyed.

Should only used as a template argument for SlicedGeometricField.

See also

Foam::fvPatchField

Source files

• slicedFvPatchField.H
• slicedFvPatchField.C

Definition at line 60 of file slicedFvPatchField.H.

Constructor & Destructor Documentation

slicedFvPatchField() [1/6]

slicedFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const Field< Type > &	completeField
	)

Definition at line 28 of file slicedFvPatchField.C.

References p.

slicedFvPatchField() [2/6]

slicedFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF
	)

Definition at line 43 of file slicedFvPatchField.C.

slicedFvPatchField() [3/6]

slicedFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const dictionary &	dict
	)

Definition at line 54 of file slicedFvPatchField.C.

References NotImplemented.

slicedFvPatchField() [4/6]

slicedFvPatchField	(	const slicedFvPatchField< Type > &	ptf,
		const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Definition at line 68 of file slicedFvPatchField.C.

References NotImplemented.

slicedFvPatchField() [5/6]

slicedFvPatchField

(

const slicedFvPatchField< Type > &

ptf

)

Definition at line 108 of file slicedFvPatchField.C.

slicedFvPatchField() [6/6]

slicedFvPatchField	(	const slicedFvPatchField< Type > &	ptf,
		const DimensionedField< Type, volMesh > &	iF
	)

Definition at line 83 of file slicedFvPatchField.C.

~slicedFvPatchField()

~slicedFvPatchField

virtual

Definition at line 139 of file slicedFvPatchField.C.

Member Function Documentation

TypeName()

TypeName

(

"sliced"

)

clone() [1/2]

Foam::tmp< Foam::fvPatchField< Type > > clone

virtual

Definition at line 97 of file slicedFvPatchField.C.

clone() [2/2]

Foam::tmp< Foam::fvPatchField< Type > > clone ( const DimensionedField< Type, volMesh > &  iF ) const

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 127 of file slicedFvPatchField.C.

fixesValue()

virtual bool fixesValue ( ) const

inlinevirtual

Definition at line 137 of file slicedFvPatchField.H.

assignable()

virtual bool assignable ( ) const

inlinevirtual

Definition at line 143 of file slicedFvPatchField.H.

snGrad()

Foam::tmp< Foam::Field< Type > > snGrad

virtual

Definition at line 150 of file slicedFvPatchField.C.

References NotImplemented.

patchInternalField() [1/2]

Foam::tmp< Foam::Field< Type > > patchInternalField

virtual

Definition at line 160 of file slicedFvPatchField.C.

References NotImplemented.

patchInternalField() [2/2]

void patchInternalField ( Field< Type > &  ) const

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 169 of file slicedFvPatchField.C.

References NotImplemented.

patchNeighbourField() [1/2]

Foam::tmp< Foam::Field< Type > > patchNeighbourField ( const Field< Type > &  iField ) const

virtual

Definition at line 178 of file slicedFvPatchField.C.

References NotImplemented.

patchNeighbourField() [2/2]

Foam::tmp< Foam::Field< Type > > patchNeighbourField

virtual

Definition at line 190 of file slicedFvPatchField.C.

References NotImplemented.

initEvaluate()

virtual void initEvaluate ( const Pstream::commsTypes  commsType = Pstream::commsTypes::blocking )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 172 of file slicedFvPatchField.H.

evaluate()

virtual void evaluate ( const Pstream::commsTypes  commsType = Pstream::commsTypes::blocking )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 180 of file slicedFvPatchField.H.

valueInternalCoeffs()

Foam::tmp< Foam::Field< Type > > valueInternalCoeffs ( const tmp< scalarField > &  ) const

virtual

Definition at line 201 of file slicedFvPatchField.C.

References NotImplemented.

valueBoundaryCoeffs()

Foam::tmp< Foam::Field< Type > > valueBoundaryCoeffs ( const tmp< scalarField > &  ) const

virtual

Definition at line 214 of file slicedFvPatchField.C.

References NotImplemented.

gradientInternalCoeffs()

Foam::tmp< Foam::Field< Type > > gradientInternalCoeffs

virtual

Definition at line 226 of file slicedFvPatchField.C.

References NotImplemented.

gradientBoundaryCoeffs()

Foam::tmp< Foam::Field< Type > > gradientBoundaryCoeffs

virtual

Definition at line 236 of file slicedFvPatchField.C.

References NotImplemented.

write()

void write ( Ostream &  os ) const

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 245 of file slicedFvPatchField.C.

References os(), and Foam::vtk::write().

Here is the call graph for this function:

operator=() [1/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 215 of file slicedFvPatchField.H.

operator=() [2/3]

virtual void operator= ( const fvPatchField< Type > &  )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 217 of file slicedFvPatchField.H.

operator+=() [1/3]

virtual void operator+= ( const fvPatchField< Type > &  )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 218 of file slicedFvPatchField.H.

operator-=() [1/3]

virtual void operator-= ( const fvPatchField< Type > &  )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 219 of file slicedFvPatchField.H.

operator*=() [1/3]

virtual void operator*= ( const fvPatchField< scalar > &  )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 220 of file slicedFvPatchField.H.

operator/=() [1/3]

virtual void operator/= ( const fvPatchField< scalar > &  )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 221 of file slicedFvPatchField.H.

operator+=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 223 of file slicedFvPatchField.H.

operator-=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 224 of file slicedFvPatchField.H.

operator*=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 226 of file slicedFvPatchField.H.

operator/=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 227 of file slicedFvPatchField.H.

operator=() [3/3]

virtual void operator= ( const Type &  )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 229 of file slicedFvPatchField.H.

operator+=() [3/3]

virtual void operator+= ( const Type &  )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 230 of file slicedFvPatchField.H.

operator-=() [3/3]

virtual void operator-= ( const Type &  )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 231 of file slicedFvPatchField.H.

operator*=() [3/3]

virtual void operator*= ( const  scalar )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 232 of file slicedFvPatchField.H.

operator/=() [3/3]

virtual void operator/= ( const  scalar )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 233 of file slicedFvPatchField.H.

---

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

• src/finiteVolume/fields/fvPatchFields/basic/sliced/slicedFvPatchField.H
• src/finiteVolume/fields/fvPatchFields/basic/sliced/slicedFvPatchField.C