Cyclic ACMI front and back plane patch field. More...

#include <cyclicACMIPointPatchField.H>

Inheritance diagram for cyclicACMIPointPatchField< Type >:

Collaboration diagram for cyclicACMIPointPatchField< Type >:

Public Member Functions
	TypeName (cyclicACMIPointPatch::typeName_())
	Runtime type information.
	cyclicACMIPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Construct from patch and internal field.
	cyclicACMIPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	cyclicACMIPointPatchField (const cyclicACMIPointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patch field onto a new patch.
	cyclicACMIPointPatchField (const cyclicACMIPointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
	Construct as copy setting internal field reference.
virtual autoPtr< pointPatchField< Type > >	clone () const
	Return a clone.
virtual autoPtr< pointPatchField< Type > >	clone (const DimensionedField< Type, pointMesh > &iF) const
	Construct and return a clone setting internal field reference.
virtual const word &	constraintType () const
	Return the constraint type this pointPatchField implements.
virtual bool	doTransform () const
	Does the patch field perform the transformation.
virtual const tensorField &	forwardT () const
	Return face transformation tensor.
virtual const tensorField &	reverseT () const
	Return neighbour-cell transformation tensor.
virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
	Evaluate the patch field.
virtual void	swapAddSeparated (const Pstream::commsTypes commsType, Field< Type > &) const
	Complete swap of patch point values and add to local values.
Public Member Functions inherited from coupledPointPatchField< Type >
	TypeName (coupledPointPatch::typeName_())
	Runtime type information.
	coupledPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Construct from patch and internal field.
	coupledPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &dict)
	Construct from patch, internal field and dictionary.
	coupledPointPatchField (const coupledPointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patch field onto a new patch.
	coupledPointPatchField (const coupledPointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
	Construct as copy setting internal field reference.
virtual bool	coupled () const
	Return true if this patch field is derived from.
virtual void	initSwapAddSeparated (const Pstream::commsTypes, Field< Type > &) const
	Initialise swap of patch point values.
Public Member Functions inherited from pointPatchField< Type >
	declareRunTimeSelectionTable (autoPtr, pointPatchField, patch,(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF),(p, iF))
	declareRunTimeSelectionTable (autoPtr, pointPatchField, patchMapper,(const pointPatchField< Type > &ptf, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const pointPatchFieldMapper &m),(dynamic_cast< const pointPatchFieldType & >(ptf), p, iF, m))
	declareRunTimeSelectionTable (autoPtr, pointPatchField, dictionary,(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const dictionary &dict),(p, iF, dict))
	pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Construct from patch and internal field.
	pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	pointPatchField (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patch field onto a new patch.
	pointPatchField (const pointPatchField< Type > &pfld, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const Type &value)
	Copy construct onto a new patch with (unused) value.
	pointPatchField (const pointPatchField< Type > &pfld, const DimensionedField< Type, pointMesh > &iF)
	Copy construct with internal field reference.
	pointPatchField (const pointPatchField< Type > &pfld)
	Copy construct.
virtual	~pointPatchField ()=default
	Destructor.
label	size () const noexcept
	Return the patch size.
const DimensionedField< Type, pointMesh > &	internalField () const noexcept
	Return const-reference to the dimensioned internal field.
const Field< Type > &	primitiveField () const noexcept
	Return const-reference to the internal field values.
template<class Type1>
void	patchInternalField (const UList< Type1 > &internalData, const labelUList &addressing, UList< Type1 > &pfld) const
	Extract field using specified addressing.
template<class Type1>
tmp< Field< Type1 > >	patchInternalField (const UList< Type1 > &internalData, const labelUList &addressing) const
	Return field created from selected internal field values given internal field reference.
template<class Type1>
tmp< Field< Type1 > >	patchInternalField (const UList< Type1 > &internalData) const
	Return field created from appropriate internal field values given internal field reference.
tmp< Field< Type > >	patchInternalField () const
	Return field created from appropriate internal field values.
template<class Type1>
void	addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
	Given the internal field and a patch field, add the patch field to the internal field.
template<class Type1>
void	addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelUList &points) const
	Given the internal field and a patch field, add selected elements of the patch field to the internal field.
template<class Type1>
void	setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelUList &meshPoints) const
	Given the internal field and a patch field, set the patch field in the internal field.
template<class Type1>
void	setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
	Given the internal field and a patch field, set the patch field in the internal field.
virtual void	autoMap (const pointPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object.
virtual void	rmap (const pointPatchField< Type > &, const labelList &)
	Reverse map the given pointPatchField onto this pointPatchField.
virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field.
virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
	Initialise evaluation of the patch field (do nothing).
virtual void	initEvaluateLocal (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
	Initialise the evaluation of the patch field after a local operation.
virtual void	evaluateLocal (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
	Evaluate the patch field after a local operation (e.g. *=).
virtual void	write (Ostream &os) const
	Write.
virtual void	operator= (const pointPatchField< Type > &)
virtual void	operator+= (const pointPatchField< Type > &)
virtual void	operator-= (const pointPatchField< Type > &)
virtual void	operator*= (const pointPatchField< scalar > &)
virtual void	operator/= (const pointPatchField< scalar > &)
virtual void	operator= (const Field< Type > &)
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)
virtual void	operator== (const pointPatchField< Type > &)
virtual void	operator== (const Field< Type > &)
virtual void	operator== (const Type &)
bool	operator!= (const pointPatchField< Type > &) const =delete
bool	operator!= (const Field< Type > &) const =delete
bool	operator!= (const Type &) const =delete
void	negate ()
	Negate the field inplace. Dummy placeholder for FieldField.
void	normalise ()
	Normalise the field inplace. Dummy placeholder for FieldField.
template<class AnyType>
Foam::autoPtr< Foam::pointPatchField< Type > >	NewCalculatedType (const pointPatchField< AnyType > &pf)
template<class Type1>
Foam::tmp< Foam::Field< Type1 > >	patchInternalField (const UList< Type1 > &internalData, const labelUList &addressing) const
template<class Type1>
Foam::tmp< Foam::Field< Type1 > >	patchInternalField (const UList< Type1 > &internalData) const
Public Member Functions inherited from pointPatchFieldBase
	TypeName ("pointPatchField")
	Runtime type information.
	pointPatchFieldBase (const pointPatch &p)
	Construct from patch.
	pointPatchFieldBase (const pointPatch &p, const word &patchType)
	Construct from patch and patch type.
	pointPatchFieldBase (const pointPatch &p, const dictionary &dict)
	Construct from patch and dictionary.
	pointPatchFieldBase (const pointPatchFieldBase &, const pointPatch &p)
	Copy construct with new patch.
	pointPatchFieldBase (const pointPatchFieldBase &)
	Copy construct.
virtual	~pointPatchFieldBase ()=default
	Destructor.
virtual bool	assignable () const
	True if the value of the patch field is altered by assignment.
virtual bool	fixesValue () const
	True if the patch field fixes a value.
const objectRegistry &	db () const
	The associated objectRegistry.
const pointPatch &	patch () const noexcept
	Return the patch.
const word &	patchType () const noexcept
	The optional patch type.
word &	patchType () noexcept
	The optional patch type.
virtual bool	constraintOverride () const
	True if the type does not correspond to the constraint type.
bool	updated () const noexcept
	True if the boundary condition has already been updated.
void	setUpdated (bool state) noexcept
	Set updated state.
bool	manipulatedMatrix () const noexcept
	True if the matrix has already been manipulated. Currently always false for pointPatchField.
void	setManipulated (bool state) noexcept
	Set matrix manipulated state. Currently a no-op for pointPatchField.
void	checkPatch (const pointPatchFieldBase &rhs) const
	Check that patches are identical.

Additional Inherited Members
Public Types inherited from pointPatchField< Type >
typedef pointPatch	Patch
	The patch type for the patch field.
typedef Type	value_type
	The value_type for the patch field.
typedef pTraits< Type >::cmptType	cmptType
	The component type for patch field.
typedef DimensionedField< Type, pointMesh >	Internal
	The internal field type associated with the patch field.
typedef calculatedPointPatchField< Type >	Calculated
	Type for a calculated patch.
Static Public Member Functions inherited from pointPatchField< Type >
template<class DerivedPatchField, class... Args>
static autoPtr< pointPatchField< Type > >	Clone (const DerivedPatchField &pf, Args &&... args)
	Clone a patch field, optionally with internal field reference etc.
static autoPtr< pointPatchField< Type > >	New (const word &patchFieldType, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF)
	Return a pointer to a new patchField created on freestore given.
static autoPtr< pointPatchField< Type > >	New (const word &patchFieldType, const word &actualPatchType, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF)
	Return a pointer to a new patchField created on freestore given.
static autoPtr< pointPatchField< Type > >	New (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from.
static autoPtr< pointPatchField< Type > >	New (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore.
static autoPtr< pointPatchField< Type > >	NewCalculatedType (const pointPatch &p)
	Return a pointer to a new calculatedPointPatchField created on.
template<class AnyType>
static autoPtr< pointPatchField< Type > >	NewCalculatedType (const pointPatchField< AnyType > &pf)
	Return a pointer to a new calculatedPointPatchField created on.
Static Public Member Functions inherited from pointPatchFieldBase
static const word &	emptyType () noexcept
	The type name for `empty` patch fields.
static const word &	calculatedType () noexcept
	The type name for `calculated` patch fields.
static const word &	zeroGradientType () noexcept
	The type name for `zeroGradient` patch fields.
static const word &	zeroValueType () noexcept
	The type name for `zeroValue` patch fields.
Static Public Attributes inherited from pointPatchFieldBase
static int	disallowGenericPatchField
	Debug switch to disallow the use of generic pointPatchField.
Protected Member Functions inherited from pointPatchFieldBase
virtual void	readDict (const dictionary &dict)
	Read dictionary entries.

Detailed Description

template<class Type>
class Foam::cyclicACMIPointPatchField< Type >

Cyclic ACMI front and back plane patch field.

Source files

Definition at line 50 of file cyclicACMIPointPatchField.H.

Constructor & Destructor Documentation

◆ cyclicACMIPointPatchField() [1/4]

template<class Type>

cyclicACMIPointPatchField	(	const pointPatch &	p,
		const DimensionedField< Type, pointMesh > &	iF )

Construct from patch and internal field.

Definition at line 28 of file cyclicACMIPointPatchField.C.

References coupledPointPatchField< Type >::coupledPointPatchField(), p, and Foam::refCast().

Referenced by cyclicACMIPointPatchField(), cyclicACMIPointPatchField(), swapAddSeparated(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cyclicACMIPointPatchField() [2/4]

template<class Type>

cyclicACMIPointPatchField	(	const pointPatch &	p,
		const DimensionedField< Type, pointMesh > &	iF,
		const dictionary &	dict )

Construct from patch, internal field and dictionary.

Definition at line 42 of file cyclicACMIPointPatchField.C.

References coupledPointPatchField< Type >::coupledPointPatchField(), dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, patchIdentifier::index(), Foam::isType(), p, pointPatchFieldBase::patch(), and Foam::refCast().

Here is the call graph for this function:

◆ cyclicACMIPointPatchField() [3/4]

template<class Type>

cyclicACMIPointPatchField	(	const cyclicACMIPointPatchField< Type > &	ptf,
		const pointPatch &	p,
		const DimensionedField< Type, pointMesh > &	iF,
		const pointPatchFieldMapper &	mapper )

Construct by mapping given patch field onto a new patch.

Definition at line 65 of file cyclicACMIPointPatchField.C.

References coupledPointPatchField< Type >::coupledPointPatchField(), cyclicACMIPointPatchField(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, patchIdentifier::index(), Foam::isType(), p, pointPatchFieldBase::patch(), and Foam::refCast().

Here is the call graph for this function:

◆ cyclicACMIPointPatchField() [4/4]

template<class Type>

cyclicACMIPointPatchField	(	const cyclicACMIPointPatchField< Type > &	ptf,
		const DimensionedField< Type, pointMesh > &	iF )

Construct as copy setting internal field reference.

Definition at line 91 of file cyclicACMIPointPatchField.C.

References coupledPointPatchField< Type >::coupledPointPatchField(), and cyclicACMIPointPatchField().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

template<class Type>

TypeName ( cyclicACMIPointPatch::typeName_() )

Runtime type information.

References cyclicACMIPointPatchField().

Here is the call graph for this function:

◆ clone() [1/2]

template<class Type>

virtual autoPtr< pointPatchField< Type > > clone ( ) const

inlinevirtual

Return a clone.

Implements coupledPointPatchField< Type >.

Definition at line 166 of file cyclicACMIPointPatchField.H.

References pointPatchField< Type >::Clone().

Here is the call graph for this function:

◆ clone() [2/2]

template<class Type>

virtual autoPtr< pointPatchField< Type > > clone ( const DimensionedField< Type, pointMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Implements coupledPointPatchField< Type >.

Definition at line 174 of file cyclicACMIPointPatchField.H.

References pointPatchField< Type >::Clone().

Here is the call graph for this function:

◆ constraintType()

template<class Type>

virtual const word & constraintType ( ) const

inlinevirtual

Return the constraint type this pointPatchField implements.

Reimplemented from pointPatchFieldBase.

Definition at line 190 of file cyclicACMIPointPatchField.H.

◆ doTransform()

template<class Type>

virtual bool doTransform ( ) const

inlinevirtual

Does the patch field perform the transformation.

Definition at line 201 of file cyclicACMIPointPatchField.H.

References Foam::is_rotational_vectorspace_v.

Referenced by swapAddSeparated().

Here is the caller graph for this function:

◆ forwardT()

template<class Type>

virtual const tensorField & forwardT ( ) const

inlinevirtual

Return face transformation tensor.

Definition at line 213 of file cyclicACMIPointPatchField.H.

Referenced by swapAddSeparated().

Here is the caller graph for this function:

◆ reverseT()

template<class Type>

virtual const tensorField & reverseT ( ) const

inlinevirtual

Return neighbour-cell transformation tensor.

Definition at line 221 of file cyclicACMIPointPatchField.H.

Referenced by swapAddSeparated().

Here is the caller graph for this function:

◆ evaluate()

template<class Type>

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

inlinevirtual

Evaluate the patch field.

Implements coupledPointPatchField< Type >.

Definition at line 232 of file cyclicACMIPointPatchField.H.

References UPstream::buffered.

◆ swapAddSeparated()

template<class Type>

void swapAddSeparated	(	const Pstream::commsTypes	commsType,
		Field< Type > &	pField ) const

virtual

Complete swap of patch point values and add to local values.

Implements coupledPointPatchField< Type >.

Definition at line 107 of file cyclicACMIPointPatchField.C.

References pointPatchField< Type >::addToInternalField(), cyclicACMIPointPatchField(), doTransform(), fld(), forwardT(), facePointPatch::index(), pointPatchField< Type >::internalField(), cyclicAMIPolyPatch::interpolate(), cyclicACMIPointPatch::neighbPatch(), cyclicAMIPolyPatch::neighbPatch(), pointPatchField< Type >::patchInternalField(), Foam::refCast(), reverseT(), and Foam::transform().

Here is the call graph for this function:

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

src/meshTools/AMIInterpolation/patches/cyclicACMI/cyclicACMIPointPatchField/cyclicACMIPointPatchField.H
src/meshTools/AMIInterpolation/patches/cyclicACMI/cyclicACMIPointPatchField/cyclicACMIPointPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cyclicACMIPointPatchField() [1/4]

◆ cyclicACMIPointPatchField() [2/4]

◆ cyclicACMIPointPatchField() [3/4]

◆ cyclicACMIPointPatchField() [4/4]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ constraintType()

◆ doTransform()

◆ forwardT()

◆ reverseT()

◆ evaluate()

◆ swapAddSeparated()