Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd. More...

Inheritance diagram for mixedFaPatchField< Type >:

Collaboration diagram for mixedFaPatchField< Type >:

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

	mixedFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
	Construct from patch and internal field. More...

	mixedFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	mixedFaPatchField (const mixedFaPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
	Construct by mapping the given mixedFaPatchField onto a new patch. More...

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

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

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

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

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

virtual Field< Type > &	refValue ()

virtual const Field< Type > &	refValue () const

virtual Field< Type > &	refGrad ()

virtual const Field< Type > &	refGrad () const

virtual scalarField &	valueFraction ()

virtual const scalarField &	valueFraction () const

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

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

virtual tmp< Field< Type > >	snGrad () const
	Return gradient at boundary. More...

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
	Evaluate the patch field. 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 faPatchField< Type > &)

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

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

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

virtual void	operator/= (const faPatchField< 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 faPatchField< Type >
	TypeName ("faPatchField")
	Runtime type information. More...

	declareRunTimeSelectionTable (tmp, faPatchField, patch,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (tmp, faPatchField, patchMapper,(const faPatchField< Type > &ptf, const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const faPatchFieldMapper &m),(dynamic_cast< const faPatchFieldType & >(ptf), p, iF, m))

	declareRunTimeSelectionTable (tmp, faPatchField, dictionary,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const dictionary &dict),(p, iF, dict))

	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
	Construct from patch and internal field. More...

	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	faPatchField (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
	Construct by mapping the given faPatchField onto a new patch. More...

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

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

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

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

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

const DimensionedField< Type, areaMesh > &	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	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...

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 tmp< Field< Type > >	patchNeighbourField () const
	Return patchField on the opposite patch of a coupled patch. More...

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

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< Field< scalar >> &) const

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const

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

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

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

virtual void	operator== (const Type &)

template<class Type2 >
Foam::tmp< Foam::faPatchField< Type > >	NewCalculatedType (const faPatchField< Type2 > &pf)

Additional Inherited Members
Public Types inherited from faPatchField< Type >
typedef faPatch	Patch

typedef calculatedFaPatchField< Type >	Calculated

Static Public Member Functions inherited from faPatchField< Type >
static tmp< faPatchField< Type > >	New (const word &patchFieldType, const word &actualPatchType, const faPatch &, const DimensionedField< Type, areaMesh > &)

static tmp< faPatchField< Type > >	New (const word &patchFieldType, const faPatch &, const DimensionedField< Type, areaMesh > &)

static tmp< faPatchField< Type > >	New (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)

static tmp< faPatchField< Type > >	New (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)

template<class Type2 >
static tmp< faPatchField< Type > >	NewCalculatedType (const faPatchField< Type2 > &)

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

Static Public Attributes inherited from faPatchField< Type >
static int	disallowGenericFaPatchField
	Debug switch to disallow the use of. More...

Detailed Description

template<class Type>
class Foam::mixedFaPatchField< Type >

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Source files

Definition at line 54 of file mixedFaPatchField.H.

Constructor & Destructor Documentation

◆ mixedFaPatchField() [1/5]

mixedFaPatchField	(	const faPatch &	p,
		const DimensionedField< Type, areaMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 34 of file mixedFaPatchField.C.

◆ mixedFaPatchField() [2/5]

mixedFaPatchField	(	const faPatch &	p,
		const DimensionedField< Type, areaMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 64 of file mixedFaPatchField.C.

References Foam::stringOps::evaluate().

Here is the call graph for this function:

◆ mixedFaPatchField() [3/5]

mixedFaPatchField	(	const mixedFaPatchField< Type > &	ptf,
		const faPatch &	p,
		const DimensionedField< Type, areaMesh > &	iF,
		const faPatchFieldMapper &	mapper
	)

Construct by mapping the given mixedFaPatchField onto a new patch.

Definition at line 48 of file mixedFaPatchField.C.

◆ mixedFaPatchField() [4/5]

mixedFaPatchField ( const mixedFaPatchField< Type > & ptf )

Construct as copy.

Definition at line 81 of file mixedFaPatchField.C.

◆ mixedFaPatchField() [5/5]

mixedFaPatchField	(	const mixedFaPatchField< Type > &	ptf,
		const DimensionedField< Type, areaMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 94 of file mixedFaPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "mixed" )

Runtime type information.

◆ clone() [1/2]

virtual tmp<faPatchField<Type> > clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented from faPatchField< Type >.

Reimplemented in inletOutletFaPatchField< Type >.

Definition at line 109 of file mixedFaPatchField.H.

◆ clone() [2/2]

virtual tmp<faPatchField<Type> > clone ( const DimensionedField< Type, areaMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from faPatchField< Type >.

Reimplemented in inletOutletFaPatchField< Type >.

Definition at line 126 of file mixedFaPatchField.H.

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

Reimplemented from faPatchField< Type >.

Definition at line 144 of file mixedFaPatchField.H.

◆ refValue() [1/2]

virtual Field<Type>& refValue ( )

inlinevirtual

Definition at line 152 of file mixedFaPatchField.H.

◆ refValue() [2/2]

virtual const Field<Type>& refValue ( ) const

inlinevirtual

Definition at line 157 of file mixedFaPatchField.H.

◆ refGrad() [1/2]

virtual Field<Type>& refGrad ( )

inlinevirtual

Definition at line 162 of file mixedFaPatchField.H.

◆ refGrad() [2/2]

virtual const Field<Type>& refGrad ( ) const

inlinevirtual

Definition at line 167 of file mixedFaPatchField.H.

◆ valueFraction() [1/2]

virtual scalarField& valueFraction ( )

inlinevirtual

Definition at line 172 of file mixedFaPatchField.H.

◆ valueFraction() [2/2]

virtual const scalarField& valueFraction ( ) const

inlinevirtual

Definition at line 177 of file mixedFaPatchField.H.

◆ autoMap()

void autoMap ( const faPatchFieldMapper & m )

virtual

Map (and resize as needed) from self given a mapping object.

Reimplemented from faPatchField< Type >.

Definition at line 110 of file mixedFaPatchField.C.

◆ rmap()

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

virtual

Reverse map the given faPatchField onto this faPatchField.

Reimplemented from faPatchField< Type >.

Definition at line 123 of file mixedFaPatchField.C.

References mixedFaPatchField< Type >::rmap().

Referenced by mixedFaPatchField< Type >::rmap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ snGrad()

Foam::tmp< Foam::Field< Type > > snGrad ( ) const

virtual

Return gradient at boundary.

Reimplemented from faPatchField< Type >.

Definition at line 163 of file mixedFaPatchField.C.

References Foam::foamVersion::patch.

◆ evaluate()

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

virtual

Evaluate the patch field.

Reimplemented from faPatchField< Type >.

Definition at line 140 of file mixedFaPatchField.C.

References Foam::stringOps::evaluate(), and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ valueInternalCoeffs()

Foam::tmp< Foam::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

Definition at line 175 of file mixedFaPatchField.C.

◆ valueBoundaryCoeffs()

Foam::tmp< Foam::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

Definition at line 185 of file mixedFaPatchField.C.

References Foam::foamVersion::patch.

◆ gradientInternalCoeffs()

Foam::tmp< Foam::Field< Type > > gradientInternalCoeffs ( ) const

virtual

Return the matrix diagonal coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from faPatchField< Type >.

Definition at line 197 of file mixedFaPatchField.C.

References Foam::foamVersion::patch.

◆ gradientBoundaryCoeffs()

Foam::tmp< Foam::Field< Type > > gradientBoundaryCoeffs ( ) const

virtual

Return the matrix source coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from faPatchField< Type >.

Definition at line 205 of file mixedFaPatchField.C.

References Foam::foamVersion::patch.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from faPatchField< Type >.

Reimplemented in inletOutletFaPatchField< Type >.

Definition at line 214 of file mixedFaPatchField.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 faPatchField< Type >.

Definition at line 239 of file mixedFaPatchField.H.

◆ operator=() [2/3]

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

inlinevirtual

Reimplemented from faPatchField< Type >.

Definition at line 241 of file mixedFaPatchField.H.

◆ operator+=() [1/3]

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

inlinevirtual

Reimplemented from faPatchField< Type >.

Definition at line 242 of file mixedFaPatchField.H.

◆ operator-=() [1/3]

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

inlinevirtual

Reimplemented from faPatchField< Type >.

Definition at line 243 of file mixedFaPatchField.H.

◆ operator*=() [1/3]

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

inlinevirtual

Reimplemented from faPatchField< Type >.

Definition at line 244 of file mixedFaPatchField.H.

◆ operator/=() [1/3]

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

inlinevirtual

Reimplemented from faPatchField< Type >.

Definition at line 245 of file mixedFaPatchField.H.

◆ operator+=() [2/3]

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

inlinevirtual

Reimplemented from faPatchField< Type >.

Definition at line 247 of file mixedFaPatchField.H.

◆ operator-=() [2/3]

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

inlinevirtual

Reimplemented from faPatchField< Type >.

Definition at line 248 of file mixedFaPatchField.H.

◆ operator*=() [2/3]

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

inlinevirtual

Reimplemented from faPatchField< Type >.

Definition at line 250 of file mixedFaPatchField.H.

◆ operator/=() [2/3]

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

inlinevirtual

Reimplemented from faPatchField< Type >.

Definition at line 251 of file mixedFaPatchField.H.

◆ operator=() [3/3]

virtual void operator= ( const Type & )

inlinevirtual

Reimplemented from faPatchField< Type >.

Definition at line 253 of file mixedFaPatchField.H.

◆ operator+=() [3/3]

virtual void operator+= ( const Type & )

inlinevirtual

Reimplemented from faPatchField< Type >.

Definition at line 254 of file mixedFaPatchField.H.

◆ operator-=() [3/3]

virtual void operator-= ( const Type & )

inlinevirtual

Reimplemented from faPatchField< Type >.

Definition at line 255 of file mixedFaPatchField.H.

◆ operator*=() [3/3]

virtual void operator*= ( const scalar )

inlinevirtual

Reimplemented from faPatchField< Type >.

Definition at line 256 of file mixedFaPatchField.H.

◆ operator/=() [3/3]

virtual void operator/= ( const scalar )

inlinevirtual

Reimplemented from faPatchField< Type >.

Definition at line 257 of file mixedFaPatchField.H.

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

src/finiteArea/fields/faPatchFields/basic/mixed/mixedFaPatchField.H
src/finiteArea/fields/faPatchFields/basic/mixed/mixedFaPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::mixedFaPatchField< Type >

Constructor & Destructor Documentation

◆ mixedFaPatchField() [1/5]

◆ mixedFaPatchField() [2/5]

◆ mixedFaPatchField() [3/5]

◆ mixedFaPatchField() [4/5]

◆ mixedFaPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ fixesValue()

◆ refValue() [1/2]

◆ refValue() [2/2]

◆ refGrad() [1/2]

◆ refGrad() [2/2]

◆ valueFraction() [1/2]

◆ valueFraction() [2/2]

◆ autoMap()

◆ rmap()

◆ snGrad()

◆ 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::mixedFaPatchField< Type >