This boundary condition provides a temperatue interface to an external application. Values are transferred as plain text files, where OpenFOAM data is written as: More...

Inheritance diagram for externalCoupledTemperatureMixedFvPatchScalarField:

[legend]

Collaboration diagram for externalCoupledTemperatureMixedFvPatchScalarField:

[legend]

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

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

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

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

	externalCoupledTemperatureMixedFvPatchScalarField (const externalCoupledTemperatureMixedFvPatchScalarField &)
	Construct as copy. More...

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

	externalCoupledTemperatureMixedFvPatchScalarField (const externalCoupledTemperatureMixedFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchField< scalar > >	clone (const DimensionedField< scalar, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

virtual	~externalCoupledTemperatureMixedFvPatchScalarField ()
	Destructor. More...

virtual void	writeHeader (Ostream &) const
	Write header. More...

virtual void	writeData (Ostream &) const
	Write data. More...

virtual void	readData (Istream &)
	Read data. More...

Public Member Functions inherited from externalCoupledMixedFvPatchField< scalar >
	TypeName ("externalCoupled")
	Runtime type information. More...

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

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

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

	externalCoupledMixedFvPatchField (const externalCoupledMixedFvPatchField &)
	Construct as copy. More...

	externalCoupledMixedFvPatchField (const externalCoupledMixedFvPatchField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference. More...

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

virtual	~externalCoupledMixedFvPatchField ()
	Destructor. More...

Public Member Functions inherited from mixedFvPatchField< scalar >
	TypeName ("mixed")
	Runtime type information. More...

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

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

	mixedFvPatchField (const mixedFvPatchField< scalar > &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given mixedFvPatchField onto a new patch. More...

	mixedFvPatchField (const mixedFvPatchField< scalar > &)
	Construct as copy. More...

	mixedFvPatchField (const mixedFvPatchField< scalar > &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference. More...

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

virtual Field< scalar > &	refValue ()

virtual const Field< scalar > &	refValue () const

virtual Field< scalar > &	refGrad ()

virtual const Field< scalar > &	refGrad () const

virtual scalarField &	valueFraction ()

virtual const scalarField &	valueFraction () const

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

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

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

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::blocking)
	Evaluate the patch field. More...

virtual tmp< Field< scalar > >	valueInternalCoeffs (const tmp< scalarField > &) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< scalar > >	valueBoundaryCoeffs (const tmp< scalarField > &) const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< scalar > >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< scalar > >	gradientBoundaryCoeffs () const
	Return the matrix source coefficients corresponding to the. More...

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

virtual void	operator= (const UList< scalar > &)

virtual void	operator= (const fvPatchField< 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< 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< scalar > &)

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

virtual void	operator/= (const scalar)

Public Member Functions inherited from fvPatchField< scalar >
	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 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=false)
	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 tmp< fvPatchField< Type > >	clone (const DimensionedField< Type, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatch &p)

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

virtual	~fvPatchField ()
	Destructor. More...

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

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

const DimensionedField< Type, volMesh > &	dimensionedInternalField () const
	Return dimensioned internal field reference. More...

const Field< Type > &	internalField () 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...

bool	manipulatedMatrix () const
	Return true if the matrix has already been manipulated. More...

virtual void	rmap (const fvPatchField< Type > &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. 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	updateCoeffs (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::blocking)
	Initialise the evaluation of the patch field. 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	writeEntryIfDifferent (Ostream &os, const word &entryName, const EntryType &value1, const EntryType &value2) const
	Helper function to write the keyword and entry only if the. More...

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

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

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

virtual void	operator== (const Type &)

Additional Inherited Members
Public Types inherited from fvPatchField< scalar >
typedef fvPatch	Patch

Static Public Member Functions inherited from fvPatchField< scalar >
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...

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< scalar >
static int	disallowGenericFvPatchField
	Debug switch to disallow the use of genericFvPatchField. More...

Detailed Description

This boundary condition provides a temperatue interface to an external application. Values are transferred as plain text files, where OpenFOAM data is written as:

# Patch: <patch name> <magSf1> <value1> <qDot1> <htc1> <magSf2> <value2> <qDot2> <htc2> <magSf3> <value3> <qDot3> <htc2> ... <magSfN> <valueN> <qDotN> <htcN>

and received as the constituent pieces of the `mixed' condition, i.e.

# Patch: <patch name> <value1> <gradient1> <valueFracion1> <value2> <gradient2> <valueFracion2> <value3> <gradient3> <valueFracion3> ... <valueN> <gradientN> <valueFracionN>

Data is sent/received as a single file for all patches from the directory

$FOAM_CASE/<commsDir>

At start-up, the boundary creates a lock file, i.e..

OpenFOAM.lock

... to signal the external source to wait. During the boundary condition update, boundary values are written to file, e.g.

<fileName>.out

The lock file is then removed, instructing the external source to take control of the program execution. When ready, the external program should create the return values, e.g. to file

<fileName>.in

... and then re-instate the lock file. The boundary condition will then read the return values, and pass program execution back to OpenFOAM.

To be used in combination with the externalCoupled functionObject.

See also: externalCoupledFunctionObject mixedFvPatchField externalCoupledMixedFvPatchField

Source files

Definition at line 98 of file externalCoupledTemperatureMixedFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ externalCoupledTemperatureMixedFvPatchScalarField() [1/5]

externalCoupledTemperatureMixedFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 47 of file externalCoupledTemperatureMixedFvPatchScalarField.C.

Referenced by externalCoupledTemperatureMixedFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ externalCoupledTemperatureMixedFvPatchScalarField() [2/5]

externalCoupledTemperatureMixedFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 71 of file externalCoupledTemperatureMixedFvPatchScalarField.C.

References dict, p, and scalarField().

Here is the call graph for this function:

◆ externalCoupledTemperatureMixedFvPatchScalarField() [3/5]

externalCoupledTemperatureMixedFvPatchScalarField	(	const externalCoupledTemperatureMixedFvPatchScalarField &	ptf,
		const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping given.

externalCoupledTemperatureMixedFvPatchScalarField onto a new patch

Definition at line 58 of file externalCoupledTemperatureMixedFvPatchScalarField.C.

◆ externalCoupledTemperatureMixedFvPatchScalarField() [4/5]

externalCoupledTemperatureMixedFvPatchScalarField ( const externalCoupledTemperatureMixedFvPatchScalarField & ecmpf )

Construct as copy.

Definition at line 115 of file externalCoupledTemperatureMixedFvPatchScalarField.C.

◆ externalCoupledTemperatureMixedFvPatchScalarField() [5/5]

externalCoupledTemperatureMixedFvPatchScalarField	(	const externalCoupledTemperatureMixedFvPatchScalarField &	ecmpf,
		const DimensionedField< scalar, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 125 of file externalCoupledTemperatureMixedFvPatchScalarField.C.

◆ ~externalCoupledTemperatureMixedFvPatchScalarField()

~externalCoupledTemperatureMixedFvPatchScalarField ( )

virtual

Destructor.

Definition at line 137 of file externalCoupledTemperatureMixedFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "externalCoupledTemperature" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Definition at line 143 of file externalCoupledTemperatureMixedFvPatchScalarField.H.

References externalCoupledTemperatureMixedFvPatchScalarField::externalCoupledTemperatureMixedFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [2/2]

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

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from externalCoupledMixedFvPatchField< scalar >.

Definition at line 160 of file externalCoupledTemperatureMixedFvPatchScalarField.H.

References externalCoupledTemperatureMixedFvPatchScalarField::externalCoupledTemperatureMixedFvPatchScalarField().

Here is the call graph for this function:

◆ writeHeader()

void writeHeader ( Ostream & os ) const

virtual

Write header.

Reimplemented from externalCoupledMixedFvPatchField< scalar >.

Definition at line 35 of file externalCoupledTemperatureMixedFvPatchScalarField.C.

References Foam::endl().

Here is the call graph for this function:

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Write data.

Reimplemented from externalCoupledMixedFvPatchField< scalar >.

Definition at line 144 of file externalCoupledTemperatureMixedFvPatchScalarField.C.

References dimensionedInternalField(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::constant::atomic::group, IOobject::groupName(), Foam::nl, turbulenceModel::propertiesName, fvPatchField::snGrad(), and token::SPACE.

Here is the call graph for this function:

◆ readData()

void readData ( Istream & is )

virtual

Read data.

Reimplemented from externalCoupledMixedFvPatchField< scalar >.

Definition at line 215 of file externalCoupledTemperatureMixedFvPatchScalarField.C.

References forAll, and ISstream::getLine().

Here is the call graph for this function:

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

src/postProcessing/functionObjects/jobControl/externalCoupled/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H
src/postProcessing/functionObjects/jobControl/externalCoupled/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ externalCoupledTemperatureMixedFvPatchScalarField() [1/5]

◆ externalCoupledTemperatureMixedFvPatchScalarField() [2/5]

◆ externalCoupledTemperatureMixedFvPatchScalarField() [3/5]

◆ externalCoupledTemperatureMixedFvPatchScalarField() [4/5]

◆ externalCoupledTemperatureMixedFvPatchScalarField() [5/5]

◆ ~externalCoupledTemperatureMixedFvPatchScalarField()

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ writeHeader()

◆ writeData()

◆ readData()