Inheritance diagram for DAFunctionWallHeatFlux:

Collaboration diagram for DAFunctionWallHeatFlux:

Public Member Functions
	TypeName ("wallHeatFlux")

	DAFunctionWallHeatFlux (const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const word functionName)

virtual	~DAFunctionWallHeatFlux ()

virtual scalar	calcFunction ()
	calculate the value of objective function More...

Public Member Functions inherited from DAFunction
	TypeName ("DAFunction")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, DAFunction, dictionary,(const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const word functionName),(mesh, daOption, daModel, daIndex, functionName))

	DAFunction (const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const word functionName)

virtual	~DAFunction ()

void	clear ()
	clear up members More...

void	calcFunctionSources ()
	calculate DAFunction::faceSources_ and DAFunction::cellSources_ More...

word	getFunctionName ()
	return the name of objective function More...

word	getFunctionType ()
	return the part of objective function More...

word	getFunctionTimeOp ()
	return the time operator such as final, sum, average, variance More...

const labelList &	getFaceSources () const
	return DAFunction::faceSources_ More...

const labelList &	getCellSources () const
	return DAFunction::cellSources_ More...

void	calcRefVar (scalar &functionValue)
	calculate (var-ref)^2 More...

Protected Attributes
scalar	Cp_ = -9999.0
	Cp used in incompressible heatFlux calculation. More...

scalar	k_ = -9999.0
	thermal conductivity for solid heatFlux calculation More...

volScalarField	wallHeatFlux_
	wall heat flux field More...

scalar	areaSum_ = -9999.0
	the area of all heat flux patches More...

bool	calcMode_
	if calculating flux per unit area or total, which mode to use More...

word	distanceMode_
	if calculating wallHeatFlux by OpenFOAMs snGrad() or DAFOAM's custom (daCustom) formulation More...

Protected Attributes inherited from DAFunction
const fvMesh &	mesh_
	fvMesh More...

const DAOption &	daOption_
	DAOption object. More...

const DAModel &	daModel_
	DAModel object. More...

const DAIndex &	daIndex_
	DAIndex object. More...

word	functionName_
	the name of the objective function More...

word	functionType_
	the type of the objective function More...

word	timeOp_
	time operator such as final, sum, or average More...

dictionary	functionDict_
	dictionary containing the information for the objective function More...

labelList	faceSources_
	a sorted list of all face sources for the objective function More...

labelList	cellSources_
	a sorted list of all cell sources for the objective function More...

scalar	scale_
	scale of the objective function More...

label	calcRefVar_
	whether to calculate (obj-ref)^2 More...

scalarList	ref_
	if calcRefVar_ is True, set the reference value list More...

Additional Inherited Members
Static Public Member Functions inherited from DAFunction
static autoPtr< DAFunction >	New (const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const word functionName)

Detailed Description

Definition at line 26 of file DAFunctionWallHeatFlux.H.

Constructor & Destructor Documentation

◆ DAFunctionWallHeatFlux()

DAFunctionWallHeatFlux	(	const fvMesh &	mesh,
		const DAOption &	daOption,
		const DAModel &	daModel,
		const DAIndex &	daIndex,
		const word	functionName
	)

Definition at line 19 of file DAFunctionWallHeatFlux.C.

References DAFunctionWallHeatFlux::calcMode_, DAFunctionWallHeatFlux::Cp_, DAFunction::daModel_, DAFunction::daOption_, DAFunctionWallHeatFlux::distanceMode_, DAFunction::functionDict_, DAOption::getAllOptions(), DAModel::getDATurbulenceModel(), DATurbulenceModel::getTurbModelType(), DAFunctionWallHeatFlux::k_, mesh, DAFunction::mesh_, and DAFunctionWallHeatFlux::wallHeatFlux_.

Here is the call graph for this function:

◆ ~DAFunctionWallHeatFlux()

virtual ~DAFunctionWallHeatFlux ( )

inlinevirtual

Definition at line 62 of file DAFunctionWallHeatFlux.H.

Member Function Documentation

◆ TypeName()

TypeName ( "wallHeatFlux" )

◆ calcFunction()

scalar calcFunction ( )

virtual

calculate the value of objective function

Implements DAFunction.

Definition at line 105 of file DAFunctionWallHeatFlux.C.

References alphaEff(), DATurbulenceModel::alphaEff(), DAFunctionWallHeatFlux::areaSum_, DAIndex::bFaceFaceI, DAIndex::bFacePatchI, DAFunctionWallHeatFlux::calcMode_, DAFunction::calcRefVar(), DAFunctionWallHeatFlux::Cp_, DAFunction::daIndex_, DAFunction::daModel_, DAFunctionWallHeatFlux::distanceMode_, DAFunction::faceSources_, forAll(), DAModel::getDATurbulenceModel(), DATurbulenceModel::getTurbModelType(), he, DAFunctionWallHeatFlux::k_, DAFunction::mesh_, DAIndex::nLocalInternalFaces, DAFunction::scale_, T, thermo, and DAFunctionWallHeatFlux::wallHeatFlux_.

Here is the call graph for this function:

Member Data Documentation

◆ Cp_

scalar Cp_ = -9999.0

protected

Cp used in incompressible heatFlux calculation.

Definition at line 32 of file DAFunctionWallHeatFlux.H.

Referenced by DAFunctionWallHeatFlux::calcFunction(), and DAFunctionWallHeatFlux::DAFunctionWallHeatFlux().

◆ k_

scalar k_ = -9999.0

protected

thermal conductivity for solid heatFlux calculation

Definition at line 35 of file DAFunctionWallHeatFlux.H.

Referenced by DAFunctionWallHeatFlux::calcFunction(), and DAFunctionWallHeatFlux::DAFunctionWallHeatFlux().

◆ wallHeatFlux_

volScalarField wallHeatFlux_

protected

wall heat flux field

Definition at line 38 of file DAFunctionWallHeatFlux.H.

Referenced by DAFunctionWallHeatFlux::calcFunction(), and DAFunctionWallHeatFlux::DAFunctionWallHeatFlux().

◆ areaSum_

scalar areaSum_ = -9999.0

protected

the area of all heat flux patches

Definition at line 41 of file DAFunctionWallHeatFlux.H.

Referenced by DAFunctionWallHeatFlux::calcFunction().

◆ calcMode_

bool calcMode_

protected

if calculating flux per unit area or total, which mode to use

Definition at line 44 of file DAFunctionWallHeatFlux.H.

Referenced by DAFunctionWallHeatFlux::calcFunction(), and DAFunctionWallHeatFlux::DAFunctionWallHeatFlux().

◆ distanceMode_

word distanceMode_

protected

if calculating wallHeatFlux by OpenFOAMs snGrad() or DAFOAM's custom (daCustom) formulation

Definition at line 47 of file DAFunctionWallHeatFlux.H.

Referenced by DAFunctionWallHeatFlux::calcFunction(), and DAFunctionWallHeatFlux::DAFunctionWallHeatFlux().

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

dafoam/src/adjoint/DAFunction/DAFunctionWallHeatFlux.H
dafoam/src/adjoint/DAFunction/DAFunctionWallHeatFlux.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DAFunctionWallHeatFlux()

◆ ~DAFunctionWallHeatFlux()

Member Function Documentation

◆ TypeName()

◆ calcFunction()

Member Data Documentation

◆ Cp_

◆ k_

◆ wallHeatFlux_

◆ areaSum_

◆ calcMode_

◆ distanceMode_