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

Inheritance diagram for slicedFvPatchField< Type >:

[legend]

Collaboration diagram for slicedFvPatchField< Type >:

[legend]

Public Member Functions
	TypeName ("sliced")
	Runtime type information. More...

	slicedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
	Construct from patch, internal field and field to slice. More...

	slicedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. Assign value later. More...

	slicedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	slicedFvPatchField (const slicedFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given slicedFvPatchField<Type> More...

	slicedFvPatchField (const slicedFvPatchField< Type > &)
	Construct as copy. More...

virtual tmp< fvPatchField< Type > >	clone () const
	Construct and return a clone. More...

	slicedFvPatchField (const slicedFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchField< Type > >	clone (const DimensionedField< Type, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

virtual	~slicedFvPatchField ()
	Destructor. More...

virtual bool	fixesValue () const
	Return true if this patch field fixes a value. More...

virtual tmp< Field< Type > >	snGrad () const
	Return patch-normal gradient. More...

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

virtual tmp< Field< Type > >	patchInternalField () const
	Return internal field next to patch as patch field. More...

virtual void	patchInternalField (Field< Type > &) const
	Return internal field next to patch as patch field. More...

virtual tmp< Field< Type > >	patchNeighbourField (const Field< Type > &iField) const
	Return neighbour coupled given internal cell data. More...

virtual tmp< Field< Type > >	patchNeighbourField () const
	Return patchField of the values on the patch or on the. More...

virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::blocking)
	Initialise the evaluation of the patch field. More...

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::blocking)
	Evaluate the patch field, sets Updated to false. More...

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
	Return the matrix source coefficients corresponding to the. More...

virtual void	write (Ostream &) const
	Write. More...

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")
	Runtime type information. More...

	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 > &)
	Construct from patch and internal field. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
	Construct from patch and internal field and patch type. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=false)
	Construct from patch, internal field and dictionary. More...

	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given fvPatchField onto a new patch. More...

	fvPatchField (const fvPatchField< Type > &)
	Construct as copy. More...

	fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchField< Type > >	clone () const
	Construct and return a clone. More...

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatch &p)

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &pf)

virtual	~fvPatchField ()
	Destructor. More...

const objectRegistry &	db () const
	Return local objectRegistry. More...

const fvPatch &	patch () const
	Return patch. More...

const DimensionedField< Type, volMesh > &	dimensionedInternalField () const
	Return dimensioned internal field reference. More...

const Field< Type > &	internalField () const
	Return internal field reference. More...

const word &	patchType () const
	Optional patch type. More...

word &	patchType ()
	Optional patch type. More...

virtual bool	fixesValue () const
	Return true if this patch field fixes a value. More...

virtual bool	coupled () const
	Return true if this patch field is coupled. More...

bool	updated () const
	Return true if the boundary condition has already been updated. More...

bool	manipulatedMatrix () const
	Return true if the matrix has already been manipulated. More...

virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const fvPatchField< Type > &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. More...

virtual tmp< Field< Type > >	snGrad () const
	Return patch-normal gradient. More...

virtual tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const
	Return patch-normal gradient for coupled-patches. More...

virtual void	updateCoeffs (const scalarField &weights)
	Update the coefficients associated with the patch field. More...

virtual tmp< Field< Type > >	patchInternalField () const
	Return internal field next to patch as patch field. More...

virtual tmp< Field< Type > >	patchNeighbourField () const
	Return patchField on the opposite patch of a coupled patch. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix source coefficients corresponding to the. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix)
	Manipulate matrix. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
	Manipulate matrix with given weights. More...

void	writeEntryIfDifferent (Ostream &os, const word &entryName, const EntryType &value1, const EntryType &value2) const
	Helper function to write the keyword and entry only if the. More...

void	check (const fvPatchField< Type > &) const
	Check fvPatchField<Type> against given fvPatchField<Type> More...

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

Static Public Member Functions inherited from fvPatchField< Type >
static tmp< fvPatchField< Type > >	New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from. More...

static tmp< fvPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore. More...

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatch &)
	Return a pointer to a new calculatedFvPatchField created on. More...

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &)
	Return a pointer to a new calculatedFvPatchField created on. More...

static const word &	calculatedType ()
	Return the type of the calculated for of fvPatchField. More...

Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField
	Debug switch to disallow the use of genericFvPatchField. More...

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

Definition at line 61 of file slicedFvPatchField.H.

Constructor & Destructor Documentation

◆ slicedFvPatchField() [1/6]

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

Construct from patch, internal field and field to slice.

Definition at line 37 of file slicedFvPatchField.C.

References UList::operator=(), and p.

Here is the call graph for this function:

◆ slicedFvPatchField() [2/6]

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

Construct from patch and internal field. Assign value later.

Definition at line 52 of file slicedFvPatchField.C.

◆ slicedFvPatchField() [3/6]

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

Construct from patch, internal field and dictionary.

Definition at line 78 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
	)

Construct by mapping the given slicedFvPatchField<Type>

onto a new patch

Definition at line 63 of file slicedFvPatchField.C.

References NotImplemented.

◆ slicedFvPatchField() [5/6]

slicedFvPatchField ( const slicedFvPatchField< Type > & ptf )

Construct as copy.

Definition at line 115 of file slicedFvPatchField.C.

References UList::operator=().

Here is the call graph for this function:

◆ slicedFvPatchField() [6/6]

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

Construct as copy setting internal field reference.

Definition at line 92 of file slicedFvPatchField.C.

References UList::operator=().

Here is the call graph for this function:

◆ ~slicedFvPatchField()

~slicedFvPatchField< Type >

virtual

Destructor.

Definition at line 145 of file slicedFvPatchField.C.

References UList::operator=().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "sliced" )

Runtime type information.

◆ clone() [1/2]

tmp< fvPatchField< Type > > clone

virtual

Construct and return a clone.

Definition at line 104 of file slicedFvPatchField.C.

◆ clone() [2/2]

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

virtual

Construct and return a clone setting internal field reference.

Reimplemented from fvPatchField< Type >.

Definition at line 133 of file slicedFvPatchField.C.

◆ fixesValue()

virtual bool fixesValue ( ) const

inlinevirtual

Return true if this patch field fixes a value.

Needed to check if a level has to be specified while solving Poissons equations.

Definition at line 138 of file slicedFvPatchField.H.

◆ snGrad()

tmp< Field< Type > > snGrad

virtual

Return patch-normal gradient.

Definition at line 156 of file slicedFvPatchField.C.

References NotImplemented, and Field::null().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs

virtual

Update the coefficients associated with the patch field.

Sets Updated to true

Reimplemented from fvPatchField< Type >.

Definition at line 165 of file slicedFvPatchField.C.

References NotImplemented.

◆ patchInternalField() [1/2]

tmp< Field< Type > > patchInternalField

virtual

Return internal field next to patch as patch field.

Definition at line 172 of file slicedFvPatchField.C.

References NotImplemented, and Field::null().

Here is the call graph for this function:

◆ patchInternalField() [2/2]

void patchInternalField ( Field< Type > & ) const

virtual

Return internal field next to patch as patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 181 of file slicedFvPatchField.C.

References NotImplemented.

◆ patchNeighbourField() [1/2]

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

virtual

Return neighbour coupled given internal cell data.

Definition at line 189 of file slicedFvPatchField.C.

References NotImplemented, and Field::null().

Here is the call graph for this function:

◆ patchNeighbourField() [2/2]

tmp< Field< Type > > patchNeighbourField

virtual

Return patchField of the values on the patch or on the.

opposite patch

Definition at line 200 of file slicedFvPatchField.C.

References NotImplemented, and Field::null().

Here is the call graph for this function:

◆ initEvaluate()

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

inlinevirtual

Initialise the evaluation of the patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 171 of file slicedFvPatchField.H.

◆ evaluate()

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

inlinevirtual

Evaluate the patch field, sets Updated to false.

Reimplemented from fvPatchField< Type >.

Definition at line 178 of file slicedFvPatchField.H.

◆ valueInternalCoeffs()

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

virtual

Return the matrix diagonal coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Reimplemented from fvPatchField< Type >.

Definition at line 210 of file slicedFvPatchField.C.

References NotImplemented, and Field::null().

Here is the call graph for this function:

◆ valueBoundaryCoeffs()

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

virtual

Return the matrix source coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Reimplemented from fvPatchField< Type >.

Definition at line 222 of file slicedFvPatchField.C.

References NotImplemented, and Field::null().

Here is the call graph for this function:

◆ gradientInternalCoeffs()

tmp< Field< Type > > gradientInternalCoeffs

virtual

Return the matrix diagonal coefficients corresponding to the.

evaluation of the gradient of this patchField

Definition at line 233 of file slicedFvPatchField.C.

References NotImplemented, and Field::null().

Here is the call graph for this function:

◆ gradientBoundaryCoeffs()

tmp< Field< Type > > gradientBoundaryCoeffs

virtual

Return the matrix source coefficients corresponding to the.

evaluation of the gradient of this patchField

Definition at line 242 of file slicedFvPatchField.C.

References NotImplemented, and Field::null().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from fvPatchField< Type >.

Definition at line 251 of file slicedFvPatchField.C.

References fvPatchField::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 212 of file slicedFvPatchField.H.

◆ operator=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 214 of file slicedFvPatchField.H.

◆ operator+=() [1/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 215 of file slicedFvPatchField.H.

◆ operator-=() [1/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 216 of file slicedFvPatchField.H.

◆ operator*=() [1/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 217 of file slicedFvPatchField.H.

◆ operator/=() [1/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 218 of file slicedFvPatchField.H.

◆ operator+=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 220 of file slicedFvPatchField.H.

◆ operator-=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 221 of file slicedFvPatchField.H.

◆ operator*=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 223 of file slicedFvPatchField.H.

◆ operator/=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 224 of file slicedFvPatchField.H.

◆ operator=() [3/3]

virtual void operator= ( const Type & )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 226 of file slicedFvPatchField.H.

◆ operator+=() [3/3]

virtual void operator+= ( const Type & )

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 228 of file slicedFvPatchField.H.

◆ operator*=() [3/3]

virtual void operator*= ( const scalar )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 229 of file slicedFvPatchField.H.

◆ operator/=() [3/3]

virtual void operator/= ( const scalar )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 230 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

Public Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ slicedFvPatchField() [1/6]

◆ slicedFvPatchField() [2/6]

◆ slicedFvPatchField() [3/6]

◆ slicedFvPatchField() [4/6]

◆ slicedFvPatchField() [5/6]

◆ slicedFvPatchField() [6/6]

◆ ~slicedFvPatchField()

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ fixesValue()

◆ snGrad()

◆ updateCoeffs()

◆ patchInternalField() [1/2]

◆ patchInternalField() [2/2]

◆ patchNeighbourField() [1/2]

◆ patchNeighbourField() [2/2]

◆ initEvaluate()

◆ evaluate()

◆ valueInternalCoeffs()

◆ valueBoundaryCoeffs()

◆ gradientInternalCoeffs()

◆ gradientBoundaryCoeffs()

◆ write()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator+=() [1/3]

◆ operator-=() [1/3]

◆ operator*=() [1/3]

◆ operator/=() [1/3]

◆ operator+=() [2/3]

◆ operator-=() [2/3]

◆ operator*=() [2/3]

◆ operator/=() [2/3]

◆ operator=() [3/3]

◆ operator+=() [3/3]

◆ operator-=() [3/3]

◆ operator*=() [3/3]

◆ operator/=() [3/3]

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