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

Inheritance diagram for cyclicAMIPointPatchField< Type >:

Collaboration diagram for cyclicAMIPointPatchField< Type >:

Public Member Functions
	TypeName (cyclicAMIPointPatch::typeName_())
	Runtime type information. More...

	cyclicAMIPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Construct from patch and internal field. More...

	cyclicAMIPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	cyclicAMIPointPatchField (const cyclicAMIPointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patchField<Type> onto a new patch. More...

virtual autoPtr< pointPatchField< Type > >	clone () const
	Construct and return a clone. More...

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

virtual autoPtr< pointPatchField< Type > >	clone (const DimensionedField< Type, pointMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

virtual const word &	constraintType () const
	Return the constraint type this pointPatchField implements. More...

virtual bool	doTransform () const
	Does the patch field perform the transformation. More...

virtual const tensorField &	forwardT () const
	Return face transformation tensor. More...

virtual const tensorField &	reverseT () const
	Return neighbour-cell transformation tensor. More...

virtual bool	coupled () const

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
	Evaluate the patch field. More...

virtual void	swapAddSeparated (const Pstream::commsTypes commsType, Field< Type > &) const
	Complete swap of patch point values and add to local values. More...

Public Member Functions inherited from coupledPointPatchField< Type >
	TypeName (coupledPointPatch::typeName_())
	Runtime type information. More...

	coupledPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Construct from patch and internal field. More...

	coupledPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &dict)
	Construct from patch, internal field and dictionary. More...

	coupledPointPatchField (const coupledPointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patchField<Type> onto a new patch. More...

virtual autoPtr< pointPatchField< Type > >	clone () const =0
	Construct and return a clone. More...

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

virtual autoPtr< pointPatchField< Type > >	clone (const DimensionedField< Type, pointMesh > &iF) const =0
	Construct and return a clone setting internal field reference. More...

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

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)=0
	Evaluate the patch field. More...

virtual void	initSwapAddSeparated (const Pstream::commsTypes, Field< Type > &) const
	Initialise swap of patch point values. More...

virtual void	swapAddSeparated (const Pstream::commsTypes, Field< Type > &) const =0
	Complete swap of patch point values and add to local values. More...

Public Member Functions inherited from pointPatchField< Type >
	TypeName ("pointPatchField")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, pointPatchField, pointPatch,(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. More...

	pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	pointPatchField (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patchField<Type> onto a new patch. More...

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

virtual autoPtr< pointPatchField< Type > >	clone () const =0
	Construct and return a clone. More...

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

virtual autoPtr< pointPatchField< Type > >	clone (const DimensionedField< Type, pointMesh > &iF) const =0
	Construct and return a clone setting internal field reference. More...

virtual	~pointPatchField ()=default
	Destructor. More...

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

label	size () const
	Return size. More...

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

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

const Field< Type > &	primitiveField () 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...

tmp< Field< Type > >	patchInternalField () const
	Return field created from appropriate internal field values. More...

template<class Type1 >
tmp< Field< Type1 > >	patchInternalField (const Field< Type1 > &iF) const
	Return field created from appropriate internal field values. More...

template<class Type1 >
tmp< Field< Type1 > >	patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const
	Return field created from selected internal field values. More...

template<class Type1 >
void	addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
	Given the internal field and a patch field,. More...

template<class Type1 >
void	addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &points) const
	Given the internal field and a patch field,. More...

template<class Type1 >
void	setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &meshPoints) const
	Given the internal field and a patch field,. More...

template<class Type1 >
void	setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
	Given the internal field and a patch field,. More...

virtual const word &	constraintType () const
	Return the constraint type this pointPatchField implements. More...

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

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

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

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

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
	Evaluate the patch field. More...

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

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 &)

void	negate ()
	Negate the field inplace. Dummy placeholder for FieldField. More...

void	normalise ()
	Normalise the field inplace. Dummy placeholder for FieldField. More...

template<class Type2 >
Foam::autoPtr< Foam::pointPatchField< Type > >	NewCalculatedType (const pointPatchField< Type2 > &pf)

template<class Type1 >
Foam::tmp< Foam::Field< Type1 > >	patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const

template<class Type1 >
Foam::tmp< Foam::Field< Type1 > >	patchInternalField (const Field< Type1 > &iF) const

Additional Inherited Members
Public Types inherited from pointPatchField< Type >
typedef Type	value_type
	The Field value_type. More...

typedef DimensionedField< Type, pointMesh >	Internal
	The internal field type associated with the patch field. More...

typedef pointPatch	Patch
	The patch type for the patch field. More...

typedef calculatedPointPatchField< Type >	Calculated
	Type for a calculated patch. More...

Static Public Member Functions inherited from pointPatchField< Type >
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. More...

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. More...

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. More...

static autoPtr< pointPatchField< Type > >	New (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore. More...

template<class Type2 >
static autoPtr< pointPatchField< Type > >	NewCalculatedType (const pointPatchField< Type2 > &)
	Return a pointer to a new calculatedPointPatchField created on. More...

static const word &	calculatedType ()
	Return the type of the calculated form of pointPatchField. More...

Static Public Attributes inherited from pointPatchField< Type >
static int	disallowGenericPointPatchField
	Debug switch to disallow the use of genericPointPatchField. More...

Detailed Description

template<class Type>
class Foam::cyclicAMIPointPatchField< Type >

Cyclic AMI front and back plane patch field.

Source files

Definition at line 54 of file cyclicAMIPointPatchField.H.

Constructor & Destructor Documentation

◆ cyclicAMIPointPatchField() [1/4]

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

Construct from patch and internal field.

Definition at line 35 of file cyclicAMIPointPatchField.C.

References Foam::refCast().

Here is the call graph for this function:

◆ cyclicAMIPointPatchField() [2/4]

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

Construct from patch, internal field and dictionary.

Definition at line 49 of file cyclicAMIPointPatchField.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, pointPatch::index(), p, and pointPatchField< Type >::patch().

Here is the call graph for this function:

◆ cyclicAMIPointPatchField() [3/4]

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

Construct by mapping given patchField<Type> onto a new patch.

Definition at line 72 of file cyclicAMIPointPatchField.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, pointPatch::index(), and pointPatchField< Type >::patch().

Here is the call graph for this function:

◆ cyclicAMIPointPatchField() [4/4]

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

Construct as copy setting internal field reference.

Definition at line 98 of file cyclicAMIPointPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( cyclicAMIPointPatch::typeName_() )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Implements coupledPointPatchField< Type >.

Definition at line 141 of file cyclicAMIPointPatchField.H.

◆ clone() [2/2]

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 160 of file cyclicAMIPointPatchField.H.

◆ constraintType()

virtual const word & constraintType ( ) const

inlinevirtual

Return the constraint type this pointPatchField implements.

Reimplemented from pointPatchField< Type >.

Definition at line 180 of file cyclicAMIPointPatchField.H.

References ensightPTraits< Type >::typeName.

◆ doTransform()

virtual bool doTransform ( ) const

inlinevirtual

Does the patch field perform the transformation.

Definition at line 189 of file cyclicAMIPointPatchField.H.

References cyclicAMIPointPatch::parallel().

Here is the call graph for this function:

◆ forwardT()

virtual const tensorField & forwardT ( ) const

inlinevirtual

Return face transformation tensor.

Definition at line 199 of file cyclicAMIPointPatchField.H.

References cyclicAMIPointPatch::forwardT().

Here is the call graph for this function:

◆ reverseT()

virtual const tensorField & reverseT ( ) const

inlinevirtual

Return neighbour-cell transformation tensor.

Definition at line 205 of file cyclicAMIPointPatchField.H.

References cyclicAMIPointPatch::reverseT().

Here is the call graph for this function:

◆ coupled()

bool coupled

virtual

Return true if coupled. Note that the underlying patch is not coupled() - the points don't align.

Reimplemented from coupledPointPatchField< Type >.

Definition at line 114 of file cyclicAMIPointPatchField.C.

◆ evaluate()

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

inlinevirtual

Evaluate the patch field.

Implements coupledPointPatchField< Type >.

Definition at line 218 of file cyclicAMIPointPatchField.H.

◆ swapAddSeparated()

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 121 of file cyclicAMIPointPatchField.C.

References fld(), facePointPatch::index(), cyclicAMIPointPatch::neighbPatch(), 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/cyclicAMI/cyclicAMIPointPatchField/cyclicAMIPointPatchField.H
src/meshTools/AMIInterpolation/patches/cyclicAMI/cyclicAMIPointPatchField/cyclicAMIPointPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cyclicAMIPointPatchField() [1/4]

◆ cyclicAMIPointPatchField() [2/4]

◆ cyclicAMIPointPatchField() [3/4]

◆ cyclicAMIPointPatchField() [4/4]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ constraintType()

◆ doTransform()

◆ forwardT()

◆ reverseT()

◆ coupled()

◆ evaluate()

◆ swapAddSeparated()