fixedNormalSlipFvPatchField< Type > Class Template Reference

This boundary condition sets the patch-normal component to the field (vector or tensor) to the patch-normal component of a user specified field. The tangential component is treated as slip, i.e. copied from the internal field. More...

Inheritance diagram for fixedNormalSlipFvPatchField< Type >:

Collaboration diagram for fixedNormalSlipFvPatchField< Type >:

Public Member Functions
	TypeName ("fixedNormalSlip")
	fixedNormalSlipFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	fixedNormalSlipFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	fixedNormalSlipFvPatchField (const fixedNormalSlipFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	fixedNormalSlipFvPatchField (const fixedNormalSlipFvPatchField< Type > &)
virtual tmp< fvPatchField< Type > >	clone () const
	fixedNormalSlipFvPatchField (const fixedNormalSlipFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
virtual tmp< fvPatchField< Type > >	clone (const DimensionedField< Type, volMesh > &iF) const
virtual bool	assignable () const
virtual Field< Type > &	fixedValue ()
virtual const Field< Type > &	fixedValue () const
virtual void	autoMap (const fvPatchFieldMapper &m)
virtual void	rmap (const fvPatchField< Type > &ptf, const labelList &addr)
virtual tmp< Field< Type > >	snGrad () const
virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
virtual tmp< Field< Type > >	snGradTransformDiag () const
virtual void	write (Ostream &) const
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")
	transformFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	transformFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	transformFvPatchField (const transformFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	transformFvPatchField (const transformFvPatchField< Type > &)
	transformFvPatchField (const transformFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const
virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const
virtual tmp< Field< Type > >	gradientInternalCoeffs () const
virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
tmp< scalarField >	valueInternalCoeffs (const tmp< scalarField > &) const
tmp< scalarField >	gradientInternalCoeffs () const
Foam::tmp< Foam::scalarField >	valueInternalCoeffs (const tmp< scalarField > &) const
Foam::tmp< Foam::scalarField >	gradientInternalCoeffs () 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 tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) 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 void	initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
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 > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const
virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
virtual tmp< Field< Type > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
virtual void	manipulateMatrix (fvMatrix< Type > &matrix)
virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp)
void	check (const fvPatchField< Type > &) const
virtual void	operator== (const fvPatchField< Type > &)
virtual void	operator== (const Field< Type > &)
virtual void	operator== (const Type &)

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

This boundary condition sets the patch-normal component to the field (vector or tensor) to the patch-normal component of a user specified field. The tangential component is treated as slip, i.e. copied from the internal field.

Usage

Example of the boundary condition specification:

<patchName>
{
    // Mandatory entries (unmodifiable)
    type            fixedNormalSlip;
    fixedValue      uniform (1 0 0);    // example entry for a vector field

    // Optional entries
    writeValue      false;

    // Mandatory/Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
type	Type name: fixedNormalSlip	word	yes	-
fixedValue	User-defined value the normal component of which the boundary is set to	vectorField/tensorField	yes	-
writeValue	Output patch values (eg, ParaView)	bool	no	false

The inherited entries are elaborated in:

• transformFvPatchField.H
• fvPatchField.H

See also

Foam::transformFvPatchField

Source files

• fixedNormalSlipFvPatchField.H
• fixedNormalSlipFvPatchField.C
• fixedNormalSlipFvPatchFields.C

Definition at line 117 of file fixedNormalSlipFvPatchField.H.

Constructor & Destructor Documentation

fixedNormalSlipFvPatchField() [1/5]

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

Definition at line 29 of file fixedNormalSlipFvPatchField.C.

fixedNormalSlipFvPatchField() [2/5]

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

Definition at line 57 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
	)

Definition at line 42 of file fixedNormalSlipFvPatchField.C.

fixedNormalSlipFvPatchField() [4/5]

fixedNormalSlipFvPatchField

(

const fixedNormalSlipFvPatchField< Type > &

ptf

)

Definition at line 74 of file fixedNormalSlipFvPatchField.C.

fixedNormalSlipFvPatchField() [5/5]

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

Definition at line 86 of file fixedNormalSlipFvPatchField.C.

Member Function Documentation

TypeName()

TypeName

(

"fixedNormalSlip"

)

clone() [1/2]

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

inlinevirtual

Implements transformFvPatchField< Type >.

Definition at line 174 of file fixedNormalSlipFvPatchField.H.

clone() [2/2]

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

inlinevirtual

Implements transformFvPatchField< Type >.

Definition at line 191 of file fixedNormalSlipFvPatchField.H.

assignable()

virtual bool assignable ( ) const

inlinevirtual

Reimplemented from transformFvPatchField< Type >.

Definition at line 207 of file fixedNormalSlipFvPatchField.H.

fixedValue() [1/2]

virtual Field<Type>& fixedValue ( )

inlinevirtual

Definition at line 213 of file fixedNormalSlipFvPatchField.H.

fixedValue() [2/2]

virtual const Field<Type>& fixedValue ( ) const

inlinevirtual

Definition at line 219 of file fixedNormalSlipFvPatchField.H.

autoMap()

void autoMap ( const fvPatchFieldMapper &  m )

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 101 of file fixedNormalSlipFvPatchField.C.

rmap()

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

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 112 of file fixedNormalSlipFvPatchField.C.

snGrad()

Foam::tmp< Foam::Field< Type > > snGrad

virtual

Implements transformFvPatchField< Type >.

Definition at line 128 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

Reimplemented from fvPatchField< Type >.

Definition at line 142 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

virtual

Implements transformFvPatchField< Type >.

Definition at line 165 of file fixedNormalSlipFvPatchField.C.

References Field::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

Reimplemented from fvPatchField< Type >.

Definition at line 179 of file fixedNormalSlipFvPatchField.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 fvPatchField< Type >.

Definition at line 263 of file fixedNormalSlipFvPatchField.H.

operator=() [2/3]

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

inlinevirtual

Reimplemented from transformFvPatchField< Type >.

Definition at line 265 of file fixedNormalSlipFvPatchField.H.

operator+=() [1/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 266 of file fixedNormalSlipFvPatchField.H.

operator-=() [1/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 267 of file fixedNormalSlipFvPatchField.H.

operator*=() [1/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 268 of file fixedNormalSlipFvPatchField.H.

operator/=() [1/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 269 of file fixedNormalSlipFvPatchField.H.

operator+=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 271 of file fixedNormalSlipFvPatchField.H.

operator-=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 272 of file fixedNormalSlipFvPatchField.H.

operator*=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 274 of file fixedNormalSlipFvPatchField.H.

operator/=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 275 of file fixedNormalSlipFvPatchField.H.

operator=() [3/3]

virtual void operator= ( const Type &  )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 277 of file fixedNormalSlipFvPatchField.H.

operator+=() [3/3]

virtual void operator+= ( const Type &  )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 278 of file fixedNormalSlipFvPatchField.H.

operator-=() [3/3]

virtual void operator-= ( const Type &  )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 279 of file fixedNormalSlipFvPatchField.H.

operator*=() [3/3]

virtual void operator*= ( const  scalar )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 280 of file fixedNormalSlipFvPatchField.H.

operator/=() [3/3]

virtual void operator/= ( const  scalar )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 281 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