Public Member Functions | Protected Attributes | List of all members
fixedJumpAMIFvPatchField< Type > Class Template Reference
Boundary conditions » Coupled

This boundary condition provides a jump condition, across non-conformal cyclic path-pairs, employing an arbitraryMeshInterface (AMI). More...

Inheritance diagram for fixedJumpAMIFvPatchField< Type >:
Inheritance graph
[legend]
Collaboration diagram for fixedJumpAMIFvPatchField< Type >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("fixedJumpAMI")
 
 fixedJumpAMIFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 
 fixedJumpAMIFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 
 fixedJumpAMIFvPatchField (const fixedJumpAMIFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
 fixedJumpAMIFvPatchField (const fixedJumpAMIFvPatchField< Type > &)
 
virtual tmp< fvPatchField< Type > > clone () const
 
 fixedJumpAMIFvPatchField (const fixedJumpAMIFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 
virtual tmp< fvPatchField< Type > > clone (const DimensionedField< Type, volMesh > &iF) const
 
virtual tmp< Field< Type > > jump () const
 
virtual void autoMap (const fvPatchFieldMapper &)
 
virtual void rmap (const fvPatchField< Type > &, const labelList &)
 
virtual void write (Ostream &) const
 
- Public Member Functions inherited from jumpCyclicAMIFvPatchField< Type >
 TypeName ("jumpCyclicAMI")
 
 jumpCyclicAMIFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 
 jumpCyclicAMIFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 
 jumpCyclicAMIFvPatchField (const jumpCyclicAMIFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
 jumpCyclicAMIFvPatchField (const jumpCyclicAMIFvPatchField< Type > &)
 
 jumpCyclicAMIFvPatchField (const jumpCyclicAMIFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 
virtual const word & interfaceFieldType () const
 
tmp< Field< Type > > patchNeighbourField () const
 
virtual void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 
virtual void updateInterfaceMatrix (Field< Type > &, const bool add, const lduAddressing &lduAddr, const label patchId, const Field< Type > &, const scalarField &, const Pstream::commsTypes commsType) const
 
void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 
void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes) const
 
- Public Member Functions inherited from cyclicAMIFvPatchField< Type >
 TypeName (cyclicAMIFvPatch::typeName_())
 
 cyclicAMIFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 
 cyclicAMIFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 
 cyclicAMIFvPatchField (const cyclicAMIFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
 cyclicAMIFvPatchField (const cyclicAMIFvPatchField< Type > &)
 
 cyclicAMIFvPatchField (const cyclicAMIFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 
const cyclicAMIFvPatch & cyclicAMIPatch () const
 
virtual bool coupled () const
 
const cyclicAMIFvPatchField< Type > & neighbourPatchField () const
 
virtual void manipulateMatrix (fvMatrix< Type > &m, const label iMatrix, const direction cmpt)
 
virtual bool doTransform () const
 
virtual const tensorField & forwardT () const
 
virtual const tensorField & reverseT () const
 
virtual int rank () const
 
- Public Member Functions inherited from cyclicAMILduInterfaceField
 TypeName ("cyclicAMILduInterfaceField")
 
 cyclicAMILduInterfaceField ()
 
virtual ~cyclicAMILduInterfaceField ()
 
template<class Type >
void transformCoupleField (Field< Type > &f) const
 
void transformCoupleField (solveScalarField &psiInternal, const direction cmpt) const
 
- Public Member Functions inherited from coupledFvPatchField< Type >
 TypeName (coupledFvPatch::typeName_())
 
 coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 
 coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
 
 coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
 
 coupledFvPatchField (const coupledFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
 coupledFvPatchField (const coupledFvPatchField< Type > &)
 
 coupledFvPatchField (const coupledFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 
virtual tmp< Field< Type > > snGrad (const scalarField &deltaCoeffs) const
 
virtual tmp< Field< Type > > snGrad () const
 
virtual void initEvaluate (const Pstream::commsTypes commsType)
 
virtual void evaluate (const Pstream::commsTypes commsType)
 
virtual tmp< Field< Type > > valueInternalCoeffs (const tmp< scalarField > &) const
 
virtual tmp< Field< Type > > valueBoundaryCoeffs (const tmp< scalarField > &) const
 
virtual tmp< Field< Type > > gradientInternalCoeffs (const scalarField &deltaCoeffs) const
 
virtual tmp< Field< Type > > gradientInternalCoeffs () const
 
virtual tmp< Field< Type > > gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
 
virtual tmp< Field< Type > > gradientBoundaryCoeffs () const
 
- Public Member Functions inherited from LduInterfaceField< Type >
 TypeName ("LduInterfaceField")
 
 LduInterfaceField (const lduInterface &patch)
 
virtual ~LduInterfaceField ()=default
 
virtual void initInterfaceMatrixUpdate (Field< Type > &, const bool add, const lduAddressing &, const label interfacei, const Field< Type > &, const scalarField &, const Pstream::commsTypes commsType) const
 
virtual void initInterfaceMatrixUpdate (solveScalarField &result, const bool add, const lduAddressing &, const label interfacei, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 
virtual void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &, const label interfacei, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const=0
 
- Public Member Functions inherited from lduInterfaceField
 TypeName ("lduInterfaceField")
 
 lduInterfaceField (const lduInterface &patch)
 
virtual ~lduInterfaceField ()=default
 
const lduInterface & interface () const
 
bool updatedMatrix () const
 
bool & updatedMatrix ()
 
virtual bool ready () const
 
virtual void initInterfaceMatrixUpdate (solveScalarField &result, const bool add, const lduAddressing &, const label interfacei, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 
template<class Type >
void addToInternalField (Field< Type > &result, const bool add, const labelUList &faceCells, const scalarField &coeffs, const Field< Type > &vals) const
 
- 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 tmp< Field< Type > > snGrad () const
 
virtual void updateCoeffs ()
 
virtual void updateWeightedCoeffs (const scalarField &weights)
 
virtual tmp< Field< Type > > patchInternalField () const
 
virtual void patchInternalField (Field< Type > &) 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 > > gradientBoundaryCoeffs () const
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix)
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
 
void check (const fvPatchField< Type > &) const
 
virtual void operator= (const UList< Type > &)
 
virtual void operator= (const fvPatchField< Type > &)
 
virtual void operator= (const Type &)
 
virtual void operator+= (const fvPatchField< Type > &)
 
virtual void operator+= (const Field< Type > &)
 
virtual void operator+= (const Type &)
 
virtual void operator-= (const fvPatchField< Type > &)
 
virtual void operator-= (const Field< Type > &)
 
virtual void operator-= (const Type &)
 
virtual void operator*= (const fvPatchField< scalar > &)
 
virtual void operator*= (const Field< scalar > &)
 
virtual void operator*= (const scalar)
 
virtual void operator/= (const fvPatchField< scalar > &)
 
virtual void operator/= (const Field< scalar > &)
 
virtual void operator/= (const scalar)
 
virtual void operator== (const fvPatchField< Type > &)
 
virtual void operator== (const Field< Type > &)
 
virtual void operator== (const Type &)
 

Protected Attributes

Field< Type > jump_
 

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::fixedJumpAMIFvPatchField< Type >

This boundary condition provides a jump condition, across non-conformal cyclic path-pairs, employing an arbitraryMeshInterface (AMI).

The jump is specified as a fixed value field, applied as an offset to the 'owner' patch.

Usage
Property Description Required Default value
patchType underlying patch type should be cyclic yes
jump current jump value yes

Example of the boundary condition specification: 

    <patchName>
    {
        type            fixedJumpAMI;
        patchType       cyclic;
        jump            uniform 10;
    }

The above example shows the use of a fixed jump of '10'.

Note
The underlying patchType should be set to cyclicAMI
See also
Foam::jumpCyclicAMIFvPatchField
Source files

Definition at line 94 of file fixedJumpAMIFvPatchField.H.

Constructor & Destructor Documentation

◆ fixedJumpAMIFvPatchField() [1/5]

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

Definition at line 27 of file fixedJumpAMIFvPatchField.C.

◆ fixedJumpAMIFvPatchField() [2/5]

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

Definition at line 53 of file fixedJumpAMIFvPatchField.C.

◆ fixedJumpAMIFvPatchField() [3/5]

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

Definition at line 39 of file fixedJumpAMIFvPatchField.C.

◆ fixedJumpAMIFvPatchField() [4/5]

fixedJumpAMIFvPatchField ( const fixedJumpAMIFvPatchField< Type > &  ptf)

Definition at line 83 of file fixedJumpAMIFvPatchField.C.

◆ fixedJumpAMIFvPatchField() [5/5]

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

Definition at line 94 of file fixedJumpAMIFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fixedJumpAMI"  )

◆ clone() [1/2]

virtual tmp<fvPatchField<Type> > clone ( ) const
inlinevirtual

Reimplemented from cyclicAMIFvPatchField< Type >.

Reimplemented in uniformJumpAMIFvPatchField< Type >.

Definition at line 147 of file fixedJumpAMIFvPatchField.H.

◆ clone() [2/2]

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

Reimplemented from cyclicAMIFvPatchField< Type >.

Reimplemented in uniformJumpAMIFvPatchField< Type >, and energyJumpAMIFvPatchScalarField.

Definition at line 164 of file fixedJumpAMIFvPatchField.H.

◆ jump()

Foam::tmp< Foam::Field< Type > > jump
virtual

Implements jumpCyclicAMIFvPatchField< Type >.

Definition at line 107 of file fixedJumpAMIFvPatchField.C.

Referenced by fixedJumpAMIFvPatchField< scalar >::jump().

Here is the caller graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper &  m)
virtual

Reimplemented from fvPatchField< Type >.

Definition at line 139 of file fixedJumpAMIFvPatchField.C.

◆ rmap()

void rmap ( const fvPatchField< Type > &  ptf,
const labelList &  addr 
)
virtual

Reimplemented from fvPatchField< Type >.

Definition at line 150 of file fixedJumpAMIFvPatchField.C.

Referenced by fixedJumpAMIFvPatchField< scalar >::rmap().

Here is the caller graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Reimplemented from cyclicAMIFvPatchField< Type >.

Reimplemented in uniformJumpAMIFvPatchField< Type >, and energyJumpAMIFvPatchScalarField.

Definition at line 164 of file fixedJumpAMIFvPatchField.C.

Referenced by energyJumpAMIFvPatchScalarField::write().

Here is the caller graph for this function:

Member Data Documentation

◆ jump_

Field<Type> jump_
protected

Definition at line 104 of file fixedJumpAMIFvPatchField.H.

Referenced by fixedJumpAMIFvPatchField< scalar >::rmap().

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17