This boundary condition sets the patch-normal component to a fixed value. More...

Inheritance diagram for fixedNormalSlipFvPatchField< Type >:

Collaboration diagram for fixedNormalSlipFvPatchField< Type >:

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

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

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

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

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

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

	fixedNormalSlipFvPatchField (const fixedNormalSlipFvPatchField< 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 bool	assignable () const
	Return false: this patch field is not altered by assignment. 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 Field< Type > &	fixedValue ()

virtual const Field< Type > &	fixedValue () const

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 > >	snGradTransformDiag () const
	Return face-gradient transform diagonal. 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 transformFvPatchField< Type >
	TypeName ("transform")
	Runtime type information. More...

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

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

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

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

	transformFvPatchField (const transformFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. 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...

template<>
tmp< scalarField >	valueInternalCoeffs (const tmp< scalarField > &) const

template<>
tmp< scalarField >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...

template<>
Foam::tmp< Foam::scalarField >	valueInternalCoeffs (const tmp< scalarField > &) const

template<>
Foam::tmp< Foam::scalarField >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...

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 Type &value)
	Construct from patch, internal field and value. 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=true)
	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	~fvPatchField ()=default
	Destructor. 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...

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

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

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

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 tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const
	Return patch-normal gradient for coupled-patches. More...

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

virtual void	updateWeightedCoeffs (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 void	patchInternalField (Field< Type > &) 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
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
	Return the matrix source 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 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	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 &)

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

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

template<class Type2 >
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::fixedNormalSlipFvPatchField< Type >

This boundary condition sets the patch-normal component to a fixed value.

Usage

Property	Description	Required	Default value
`fixedValue`	fixed value	yes

Example of the boundary condition specification:

    <patchName>
    {
        type            fixedNormalSlip;
        fixedValue      uniform 0;     // example entry for a scalar field
    }

See also: Foam::transformFvPatchField

Source files

Definition at line 82 of file fixedNormalSlipFvPatchField.H.

Constructor & Destructor Documentation

◆ fixedNormalSlipFvPatchField() [1/5]

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

Construct from patch and internal field.

Definition at line 37 of file fixedNormalSlipFvPatchField.C.

◆ fixedNormalSlipFvPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 63 of file fixedNormalSlipFvPatchField.C.

References dict, and Foam::stringOps::evaluate().

Here is the call graph for this function:

◆ fixedNormalSlipFvPatchField() [3/5]

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

Construct by mapping given fixedNormalSlipFvPatchField.

onto a new patch

Definition at line 49 of file fixedNormalSlipFvPatchField.C.

◆ fixedNormalSlipFvPatchField() [4/5]

fixedNormalSlipFvPatchField ( const fixedNormalSlipFvPatchField< Type > & ptf )

Construct as copy.

Definition at line 79 of file fixedNormalSlipFvPatchField.C.

◆ fixedNormalSlipFvPatchField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 90 of file fixedNormalSlipFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fixedNormalSlip" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Implements transformFvPatchField< Type >.

Definition at line 132 of file fixedNormalSlipFvPatchField.H.

◆ clone() [2/2]

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

inlinevirtual

Construct and return a clone setting internal field reference.

Implements transformFvPatchField< Type >.

Definition at line 149 of file fixedNormalSlipFvPatchField.H.

◆ assignable()

virtual bool assignable ( ) const

inlinevirtual

Return false: this patch field is not altered by assignment.

Reimplemented from transformFvPatchField< Type >.

Definition at line 165 of file fixedNormalSlipFvPatchField.H.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

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

Reimplemented from fvPatchField< Type >.

Definition at line 104 of file fixedNormalSlipFvPatchField.C.

◆ rmap()

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

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Reimplemented from fvPatchField< Type >.

Definition at line 115 of file fixedNormalSlipFvPatchField.C.

References fixedNormalSlipFvPatchField< Type >::rmap().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fixedValue() [1/2]

virtual Field<Type>& fixedValue ( )

inlinevirtual

Definition at line 189 of file fixedNormalSlipFvPatchField.H.

◆ fixedValue() [2/2]

virtual const Field<Type>& fixedValue ( ) const

inlinevirtual

Definition at line 194 of file fixedNormalSlipFvPatchField.H.

◆ snGrad()

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

virtual

Return gradient at boundary.

Implements transformFvPatchField< Type >.

Definition at line 131 of file fixedNormalSlipFvPatchField.C.

References Foam::I, Foam::foamVersion::patch, Foam::sqr(), and Foam::transform().

Here is the call graph for this function:

◆ evaluate()

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

virtual

Evaluate the patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 145 of file fixedNormalSlipFvPatchField.C.

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

Here is the call graph for this function:

◆ snGradTransformDiag()

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

virtual

Return face-gradient transform diagonal.

Implements transformFvPatchField< Type >.

Definition at line 168 of file fixedNormalSlipFvPatchField.C.

References Field< Type >::component(), Foam::diag(), Foam::mag(), Foam::foamVersion::patch, Foam::pow(), and Y.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from fvPatchField< Type >.

Definition at line 182 of file fixedNormalSlipFvPatchField.C.

References Foam::vtk::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 222 of file fixedNormalSlipFvPatchField.H.

◆ operator=() [2/3]

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

inlinevirtual

Reimplemented from transformFvPatchField< Type >.

Definition at line 224 of file fixedNormalSlipFvPatchField.H.

◆ operator+=() [1/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 225 of file fixedNormalSlipFvPatchField.H.

◆ operator-=() [1/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 226 of file fixedNormalSlipFvPatchField.H.

◆ operator*=() [1/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 227 of file fixedNormalSlipFvPatchField.H.

◆ operator/=() [1/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 228 of file fixedNormalSlipFvPatchField.H.

◆ operator+=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 230 of file fixedNormalSlipFvPatchField.H.

◆ operator-=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 231 of file fixedNormalSlipFvPatchField.H.

◆ operator*=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 233 of file fixedNormalSlipFvPatchField.H.

◆ operator/=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 234 of file fixedNormalSlipFvPatchField.H.

◆ operator=() [3/3]

virtual void operator= ( const Type & )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 236 of file fixedNormalSlipFvPatchField.H.

◆ operator+=() [3/3]

virtual void operator+= ( const Type & )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 237 of file fixedNormalSlipFvPatchField.H.

◆ operator-=() [3/3]

virtual void operator-= ( const Type & )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 238 of file fixedNormalSlipFvPatchField.H.

◆ operator*=() [3/3]

virtual void operator*= ( const scalar )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 239 of file fixedNormalSlipFvPatchField.H.

◆ operator/=() [3/3]

virtual void operator/= ( const scalar )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 240 of file fixedNormalSlipFvPatchField.H.

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

src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::fixedNormalSlipFvPatchField< Type >

Constructor & Destructor Documentation

◆ fixedNormalSlipFvPatchField() [1/5]

◆ fixedNormalSlipFvPatchField() [2/5]

◆ fixedNormalSlipFvPatchField() [3/5]

◆ fixedNormalSlipFvPatchField() [4/5]

◆ fixedNormalSlipFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ assignable()

◆ autoMap()

◆ rmap()

◆ fixedValue() [1/2]

◆ fixedValue() [2/2]

◆ snGrad()

◆ evaluate()

◆ snGradTransformDiag()

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