Sample probe for temperature using a thermocouple. More...

Inheritance diagram for thermoCoupleProbes:

Collaboration diagram for thermoCoupleProbes:

[legend]

Public Member Functions
	TypeName ("thermoCoupleProbes")

	thermoCoupleProbes (const word &name, const Time &runTime, const dictionary &dict, const bool loadFromFiles=false, const bool readFields=true)

virtual	~thermoCoupleProbes ()

virtual label	nEqns () const

virtual void	derivatives (const scalar x, const scalarField &y, scalarField &dydx) const

virtual void	jacobian (const scalar t, const scalarField &y, scalarField &dfdt, scalarSquareMatrix &dfdy) const

virtual bool	write ()

virtual bool	execute ()

virtual bool	read (const dictionary &)

Public Member Functions inherited from probes
	TypeName ("probes")

	probes (const word &name, const Time &runTime, const dictionary &dict, const bool loadFromFiles=false, const bool readFields=true)

virtual	~probes ()=default

virtual const wordRes &	fieldNames () const

virtual const pointField &	probeLocations () const

virtual const point &	probe (const label i) const

const labelList &	elements () const

virtual void	updateMesh (const mapPolyMesh &)

virtual void	movePoints (const polyMesh &)

virtual void	readUpdate (const polyMesh::readUpdateState state)

template<class Type >
tmp< Field< Type > >	sample (const GeometricField< Type, fvPatchField, volMesh > &) const

template<class Type >
tmp< Field< Type > >	sample (const word &fieldName) const

template<class Type >
tmp< Field< Type > >	sampleSurfaceFields (const word &fieldName) const

template<class Type >
tmp< Field< Type > >	sample (const GeometricField< Type, fvsPatchField, surfaceMesh > &) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	sample (const GeometricField< Type, fvPatchField, volMesh > &vField) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	sample (const word &fieldName) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	sample (const GeometricField< Type, fvsPatchField, surfaceMesh > &sField) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	sampleSurfaceFields (const word &fieldName) const

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)

virtual	~stateFunctionObject ()=default

dictionary &	propertyDict ()

bool	foundProperty (const word &entryName) const

void	clearTrigger ()

label	getTrigger () const

bool	setTrigger (const label triggeri, bool increaseOnly=true)

bool	getDict (const word &entryName, dictionary &dict) const

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
bool	getProperty (const word &entryName, Type &value) const

template<class Type >
void	setProperty (const word &entryName, const Type &value)

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)

template<class Type >
void	setResult (const word &entryName, const Type &value)

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)

template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const

word	resultType (const word &entryName) const

word	objectResultType (const word &objectName, const word &entryName) const

wordList	objectResultEntries () const

wordList	objectResultEntries (const word &objectName) const

void	writeResultEntries (Ostream &os) const

void	writeResultEntries (const word &objectName, Ostream &os) const

void	writeAllResultEntries (Ostream &os) const

Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)

virtual	~timeFunctionObject ()=default

const Time &	time () const

objectRegistry &	storedObjects ()

const objectRegistry &	storedObjects () const

Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)

autoPtr< functionObject >	clone () const

virtual	~functionObject ()=default

virtual const word &	type () const =0

const word &	name () const noexcept

bool	useNamePrefix () const noexcept

bool	useNamePrefix (bool on) noexcept

virtual bool	execute (const label subIndex)

virtual bool	end ()

virtual bool	adjustTimeStep ()

virtual bool	filesModified () const

Public Member Functions inherited from Field
constexpr	Field () noexcept

	Field (const label len)

	Field (const label len, const Type &val)

	Field (const label len, const Foam::zero)

	Field (const Foam::one, const Type &val)

	Field (const Foam::one, Type &&val)

	Field (const Foam::one, const Foam::zero)

	Field (const Field< Type > &fld)

	Field (const UList< Type > &list)

template<class Addr >
	Field (const IndirectListBase< Type, Addr > &list)

	Field (Field< Type > &&fld)

	Field (List< Type > &&list)

template<int SizeMin>
	Field (DynamicList< Type, SizeMin > &&list)

	Field (const UList< Type > &mapF, const labelUList &mapAddressing)

	Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)

	Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)

	Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)

	Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)

	Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)

	Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)

	Field (Field< Type > &fld, bool reuse)

	Field (const tmp< Field< Type >> &tfld)

	Field (Istream &is)

	Field (const word &keyword, const dictionary &dict, const label len)

tmp< Field< Type > >	clone () const

void	map (const UList< Type > &mapF, const labelUList &mapAddressing)

void	map (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)

void	map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)

void	map (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)

void	map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)

void	map (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)

void	autoMap (const FieldMapper &map, const bool applyFlip=true)

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing)

void	rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)

void	rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)

void	negate ()

tmp< Field< cmptType > >	component (const direction) const

void	replace (const direction, const UList< cmptType > &)

void	replace (const direction, const tmp< Field< cmptType >> &)

void	replace (const direction, const cmptType &)

template<class VSForm >
VSForm	block (const label start) const

tmp< Field< Type > >	T () const

void	writeEntry (const word &keyword, Ostream &os) const

SubField< Type >	slice (const label pos, label len=-1)

const SubField< Type >	slice (const label pos, label len=-1) const

SubField< Type >	slice (const labelRange &range)

const SubField< Type >	slice (const labelRange &range) const

void	operator= (const Field< Type > &)

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

void	operator= (const UList< Type > &rhs)

void	operator= (const SubField< Type > &rhs)

template<class Addr >
void	operator= (const IndirectListBase< Type, Addr > &rhs)

void	operator= (Field< Type > &&rhs)

void	operator= (List< Type > &&rhs)

template<int SizeMin>
void	operator= (DynamicList< Type, SizeMin > &&rhs)

void	operator= (const Type &val)

void	operator= (const Foam::zero)

template<class Form , class Cmpt , direction nCmpt>
void	operator= (const VectorSpace< Form, Cmpt, nCmpt > &)

void	operator+= (const UList< Type > &)

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

void	operator-= (const UList< Type > &)

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

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

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

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

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

void	operator+= (const Type &)

void	operator-= (const Type &)

void	operator*= (const scalar &)

void	operator/= (const scalar &)

template<class Type >
	Field (const UList< Type > &mapF, const labelUList &mapAddressing)

template<class Type >
	Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)

template<class Type >
	Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &mapWeights)

template<class Type >
	Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &mapWeights)

template<class Type >
	Field (const UList< Type > &mapF, const FieldMapper &mapper, const bool applyFlip)

template<class Type >
	Field (const UList< Type > &mapF, const FieldMapper &mapper, const Type &defaultValue, const bool applyFlip)

template<class Type >
	Field (const UList< Type > &mapF, const FieldMapper &mapper, const UList< Type > &defaultValues, const bool applyFlip)

template<class Type >
	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &mapper, const bool applyFlip)

template<class Type >
	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &mapper, const Type &defaultValue, const bool applyFlip)

template<class Type >
	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &mapper, const UList< Type > &defaultValues, const bool applyFlip)

template<class Type >
	Field (const word &keyword, const dictionary &dict, const label len)

template<class Type >
void	operator= (const Field< Type > &rhs)

template<class Type >
void	operator= (const tmp< Field > &rhs)

template<class Type >
constexpr	Field () noexcept

template<class Type >
	Field (const label len)

template<class Type >
	Field (const label len, const Type &val)

template<class Type >
	Field (const label len, const Foam::zero)

template<class Type >
	Field (const Foam::one, const Type &val)

template<class Type >
	Field (const Foam::one, Type &&val)

template<class Type >
	Field (const Foam::one, const Foam::zero)

template<class Type >
	Field (const Field< Type > &fld)

template<class Type >
	Field (const UList< Type > &list)

template<class Type >
	Field (Field< Type > &&fld)

template<class Type >
	Field (List< Type > &&list)

template<class Type >
	Field (Field< Type > &fld, bool reuse)

template<class Type >
	Field (const tmp< Field< Type >> &tfld)

template<class Type >
	Field (Istream &is)

template<class Type >
void	operator= (const UList< Type > &rhs)

template<class Type >
void	operator= (const SubField< Type > &rhs)

template<class Type >
void	operator= (Field< Type > &&rhs)

template<class Type >
void	operator= (List< Type > &&rhs)

template<class Type >
void	operator= (const Type &val)

template<class Type >
void	operator= (const Foam::zero)

Public Member Functions inherited from ODESystem
	ODESystem ()

virtual	~ODESystem ()=default

Protected Member Functions
template<class Type >
void	sampleAndWrite (const GeometricField< Type, fvPatchField, volMesh > &)

Protected Member Functions inherited from probes
void	clearFieldGroups ()

label	classifyFields ()

virtual void	findElements (const fvMesh &mesh)

label	prepare ()

Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const

functionObjects::properties &	stateDict ()

	stateFunctionObject (const stateFunctionObject &)=delete

void	operator= (const stateFunctionObject &)=delete

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)

	timeFunctionObject (const timeFunctionObject &)=delete

void	operator= (const timeFunctionObject &)=delete

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const

Protected Attributes
scalar	rho_

scalar	Cp_

scalar	d_

scalar	epsilon_

word	UName_

word	radiationFieldName_

const fluidThermo &	thermo_

autoPtr< ODESolver >	odeSolver_

scalarField	Ttc_

Protected Attributes inherited from probes
const fvMesh &	mesh_

bool	loadFromFiles_

wordRes	fieldSelection_

bool	fixedLocations_

word	interpolationScheme_

bool	includeOutOfBounds_

fieldGroup< scalar >	scalarFields_

fieldGroup< vector >	vectorFields_

fieldGroup< sphericalTensor >	sphericalTensorFields_

fieldGroup< symmTensor >	symmTensorFields_

fieldGroup< tensor >	tensorFields_

fieldGroup< scalar >	surfaceScalarFields_

fieldGroup< vector >	surfaceVectorFields_

fieldGroup< sphericalTensor >	surfaceSphericalTensorFields_

fieldGroup< symmTensor >	surfaceSymmTensorFields_

fieldGroup< tensor >	surfaceTensorFields_

labelList	elementList_

labelList	faceList_

labelList	processor_

HashPtrTable< OFstream >	probeFilePtrs_

labelList	patchIDList_

pointField	oldPoints_

Protected Attributes inherited from timeFunctionObject
const Time &	time_

Additional Inherited Members
Public Types inherited from Field
typedef pTraits< Type >::cmptType	cmptType

typedef SubField< Type >	subField

Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)

Static Public Member Functions inherited from Field
static const Field< Type > &	null ()

static autoPtr< Field< Type > >	New (Istream &is)

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

Public Attributes inherited from functionObject
bool	log

Static Public Attributes inherited from functionObject
static int	debug

static bool	postProcess

static bool	defaultUseNamePrefix

static word	outputPrefix

Detailed Description

Sample probe for temperature using a thermocouple.

Uses the correlation:

$Nu = 2.0 + \left(0.4 Re^{0.5} + 0.06 Re^{2/3}\right)*Pr^{0.4}$

Usage

Example of function object specification:

probes
{
    type            thermoCoupleProbes;
    libs            (utilityFunctionObjects);
    writeControl    timeStep;
    writeInterval   1;

    solver          rodas23;
    absTol          1e-12;
    relTol          1e-8;

    interpolationScheme cellPoint;

    // thermocouple properties
    rho             8908;
    Cp              440;
    d               1e-3;
    epsilon         0.85;

    radiationField  G;

    probeLocations
    (
        (0.5 0.5 0.5)
    );
    fields
    (
        T
    );
}

Source files

Definition at line 97 of file thermoCoupleProbes.H.

Constructor & Destructor Documentation

◆ thermoCoupleProbes()

thermoCoupleProbes	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict,
		const bool	loadFromFiles = `false`,
		const bool	readFields = `true`
	)

Definition at line 43 of file thermoCoupleProbes.C.

References dict, ODESolver::New(), Foam::read(), dictionary::readEntry(), and probes::sample().

Here is the call graph for this function:

◆ ~thermoCoupleProbes()

~thermoCoupleProbes ( )

virtual

Definition at line 84 of file thermoCoupleProbes.C.

Member Function Documentation

◆ sampleAndWrite()

void sampleAndWrite ( const GeometricField< Type, fvPatchField, volMesh > & vField )

protected

Definition at line 25 of file thermoCoupleProbesTemplates.C.

References Foam::endl(), forAll, and Foam::setw().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "thermoCoupleProbes" )

◆ nEqns()

Foam::label nEqns ( ) const

virtual

Implements ODESystem.

Definition at line 88 of file thermoCoupleProbes.C.

◆ derivatives()

void derivatives	(	const scalar	x,
		const scalarField &	y,
		scalarField &	dydx
	)		const

virtual

Implements ODESystem.

Definition at line 95 of file thermoCoupleProbes.C.

References Foam::fieldTypes::area, Foam::constant::universal::G, Foam::mag(), Foam::max(), Foam::constant::mathematical::pi(), Foam::pow(), Foam::pow3(), Foam::pow4(), Pr(), Foam::Re(), probes::sample(), sigma(), Foam::constant::physicoChemical::sigma, Foam::sqr(), Foam::sqrt(), dimensioned::value(), Foam::fieldTypes::volume, y, and Foam::Zero.

Here is the call graph for this function:

◆ jacobian()

void jacobian	(	const scalar	t,
		const scalarField &	y,
		scalarField &	dfdt,
		scalarSquareMatrix &	dfdy
	)		const

virtual

Implements ODESystem.

Definition at line 141 of file thermoCoupleProbes.C.

References n, x, and y.

◆ write()

bool write ( )

virtual

Reimplemented from probes.

Definition at line 162 of file thermoCoupleProbes.C.

References dictionary::add().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Reimplemented from probes.

Definition at line 178 of file thermoCoupleProbes.C.

◆ read()

bool read ( const dictionary & dict )

virtual

Reimplemented from probes.

Definition at line 192 of file thermoCoupleProbes.C.

References dict, and probes::read().

Here is the call graph for this function:

Member Data Documentation

◆ rho_

scalar rho_

protected

Definition at line 107 of file thermoCoupleProbes.H.

◆ Cp_

scalar Cp_

protected

Definition at line 110 of file thermoCoupleProbes.H.

◆ d_

scalar d_

protected

Definition at line 113 of file thermoCoupleProbes.H.

◆ epsilon_

scalar epsilon_

protected

Definition at line 116 of file thermoCoupleProbes.H.

◆ UName_

word UName_

protected

Definition at line 119 of file thermoCoupleProbes.H.

◆ radiationFieldName_

word radiationFieldName_

protected

Definition at line 122 of file thermoCoupleProbes.H.

◆ thermo_

const fluidThermo& thermo_

protected

Definition at line 125 of file thermoCoupleProbes.H.

◆ odeSolver_

autoPtr<ODESolver> odeSolver_

protected

Definition at line 128 of file thermoCoupleProbes.H.

◆ Ttc_

scalarField Ttc_

protected

Definition at line 131 of file thermoCoupleProbes.H.

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

src/functionObjects/utilities/thermoCoupleProbes/thermoCoupleProbes.H
src/functionObjects/utilities/thermoCoupleProbes/thermoCoupleProbes.C
src/functionObjects/utilities/thermoCoupleProbes/thermoCoupleProbesTemplates.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ thermoCoupleProbes()

◆ ~thermoCoupleProbes()

Member Function Documentation

◆ sampleAndWrite()

◆ TypeName()

◆ nEqns()

◆ derivatives()

◆ jacobian()

◆ write()

◆ execute()

◆ read()

Member Data Documentation

◆ rho_

◆ Cp_

◆ d_

◆ epsilon_

◆ UName_

◆ radiationFieldName_

◆ thermo_

◆ odeSolver_

◆ Ttc_