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

Inheritance diagram for inletOutletFaPatchField< Type >:

Collaboration diagram for inletOutletFaPatchField< Type >:

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

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

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

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

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

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

	inletOutletFaPatchField (const inletOutletFaPatchField< 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	~inletOutletFaPatchField ()=default
	Destructor. More...

const word &	phiName () const
	Return the name of phi. More...

word &	phiName ()
	Return reference to the name of phi to allow adjustment. More...

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

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

Public Member Functions inherited from mixedFaPatchField< Type >
	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...

	mixedFaPatchField (const mixedFaPatchField< Type > &, const DimensionedField< Type, areaMesh > &)
	Construct as copy 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	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 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
	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...

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)

Protected Attributes
word	phiName_

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 > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< faPatchField< Type > >	New (const word &patchFieldType, const faPatch &, const DimensionedField< Type, areaMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< faPatchField< Type > >	New (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from. More...

static tmp< faPatchField< Type > >	New (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore. More...

template<class Type2 >
static tmp< faPatchField< Type > >	NewCalculatedType (const faPatchField< Type2 > &)
	Return a pointer to a new calculatedFaPatchField created on. More...

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

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Source files

Definition at line 55 of file inletOutletFaPatchField.H.

Constructor & Destructor Documentation

◆ inletOutletFaPatchField() [1/5]

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

Construct from patch and internal field.

Definition at line 35 of file inletOutletFaPatchField.C.

◆ inletOutletFaPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 65 of file inletOutletFaPatchField.C.

References dict, and p.

◆ inletOutletFaPatchField() [3/5]

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

Construct by mapping given inletOutletFaPatchField onto a new patch.

Definition at line 51 of file inletOutletFaPatchField.C.

◆ inletOutletFaPatchField() [4/5]

inletOutletFaPatchField ( const inletOutletFaPatchField< Type > & ptf )

Construct as copy.

Definition at line 95 of file inletOutletFaPatchField.C.

◆ inletOutletFaPatchField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 106 of file inletOutletFaPatchField.C.

◆ ~inletOutletFaPatchField()

virtual ~inletOutletFaPatchField ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "inletOutlet" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Reimplemented from mixedFaPatchField< Type >.

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

Definition at line 123 of file inletOutletFaPatchField.H.

◆ phiName() [1/2]

const word& phiName ( ) const

inline

Return the name of phi.

Definition at line 143 of file inletOutletFaPatchField.H.

References inletOutletFaPatchField< Type >::phiName_.

◆ phiName() [2/2]

word& phiName ( )

inline

Return reference to the name of phi to allow adjustment.

Definition at line 149 of file inletOutletFaPatchField.H.

References inletOutletFaPatchField< Type >::phiName_.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Reimplemented from faPatchField< Type >.

Definition at line 119 of file inletOutletFaPatchField.C.

References Foam::foamVersion::patch, and Foam::pos().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from mixedFaPatchField< Type >.

Definition at line 139 of file inletOutletFaPatchField.C.

References Foam::vtk::write(), and Ostream::writeEntryIfDifferent().

Here is the call graph for this function:

Member Data Documentation

◆ phiName_

word phiName_

protected

Definition at line 64 of file inletOutletFaPatchField.H.

Referenced by inletOutletFaPatchField< Type >::phiName().

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

src/finiteArea/fields/faPatchFields/derived/inletOutlet/inletOutletFaPatchField.H
src/finiteArea/fields/faPatchFields/derived/inletOutlet/inletOutletFaPatchField.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class Type> class Foam::inletOutletFaPatchField< Type >

Constructor & Destructor Documentation

◆ inletOutletFaPatchField() [1/5]

◆ inletOutletFaPatchField() [2/5]

◆ inletOutletFaPatchField() [3/5]

◆ inletOutletFaPatchField() [4/5]

◆ inletOutletFaPatchField() [5/5]

◆ ~inletOutletFaPatchField()

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ phiName() [1/2]

◆ phiName() [2/2]

◆ updateCoeffs()

◆ write()

Member Data Documentation

◆ phiName_

template<class Type>
class Foam::inletOutletFaPatchField< Type >