DAResidualHeatTransferFoam Class Reference

Inheritance diagram for DAResidualHeatTransferFoam:

Collaboration diagram for DAResidualHeatTransferFoam:

These are state variables, state residuals, and partial derivatives
volScalarField &	T_
volScalarField	TRes_
volScalarField &	fvSource_
autoPtr< dimensionedScalar >	kPtr_
label	hasFvSource_ = 0
	TypeName ("DAHeatTransferFoam")
	DAResidualHeatTransferFoam (const word modelType, const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex)
virtual	~DAResidualHeatTransferFoam ()
virtual void	clear ()
	clear the members More...
virtual void	calcResiduals (const dictionary &options)
	compute residual More...
virtual void	updateIntermediateVariables ()
	update any intermediate variables that are dependent on state variables and are used in calcResiduals More...
virtual void	correctBoundaryConditions ()
	update the boundary condition for all the states in the selected solver More...

Additional Inherited Members
Public Member Functions inherited from DAResidual
	TypeName ("DAResidual")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, DAResidual, dictionary,(const word modelType, const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex),(modelType, mesh, daOption, daModel, daIndex))
	DAResidual (const word modelType, const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex)
virtual	~DAResidual ()
void	masterFunction (const dictionary &options, const Vec xvVec, const Vec wVec, Vec resVec)
	the master function that compute the residual vector given the state and point vectors More...
virtual void	calcPCMatWithFvMatrix (Mat PCMat)
	calculating the adjoint preconditioner matrix using fvMatrix More...
bool	writeData (Ostream &os) const
	virtual function for regIOobject More...
Static Public Member Functions inherited from DAResidual
static autoPtr< DAResidual >	New (const word modelType, const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex)
Protected Attributes inherited from DAResidual
const fvMesh &	mesh_
	fvMesh More...
const DAOption &	daOption_
	DAOption object. More...
const DAModel &	daModel_
	DAModel object. More...
const DAIndex &	daIndex_
	DAIndex. More...
DAField	daField_
	DAField object. More...

Detailed Description

Definition at line 26 of file DAResidualHeatTransferFoam.H.

Constructor & Destructor Documentation

DAResidualHeatTransferFoam()

DAResidualHeatTransferFoam	(	const word	modelType,
		const fvMesh &	mesh,
		const DAOption &	daOption,
		const DAModel &	daModel,
		const DAIndex &	daIndex
	)

Definition at line 19 of file DAResidualHeatTransferFoam.C.

References allOptions, DAOption::getAllOptions(), DAResidualHeatTransferFoam::hasFvSource_, DAResidualHeatTransferFoam::kPtr_, and DAResidual::mesh_.

Here is the call graph for this function:

~DAResidualHeatTransferFoam()

virtual ~DAResidualHeatTransferFoam ( )

inlinevirtual

Definition at line 55 of file DAResidualHeatTransferFoam.H.

Member Function Documentation

TypeName()

TypeName

(

"DAHeatTransferFoam"

)

clear()

void clear ( )

virtual

clear the members

Implements DAResidual.

Definition at line 54 of file DAResidualHeatTransferFoam.C.

References DAResidualHeatTransferFoam::TRes_.

calcResiduals()

void calcResiduals ( const dictionary &  options )

virtual

compute residual

Implements DAResidual.

Definition at line 65 of file DAResidualHeatTransferFoam.C.

References DAFvSource::calcFvSource(), DAResidualHeatTransferFoam::fvSource_, DAResidualHeatTransferFoam::hasFvSource_, DAResidualHeatTransferFoam::kPtr_, DAResidual::mesh_, normalizeResiduals, DAResidualHeatTransferFoam::T_, TEqn(), and DAResidualHeatTransferFoam::TRes_.

Here is the call graph for this function:

updateIntermediateVariables()

void updateIntermediateVariables ( )

virtual

update any intermediate variables that are dependent on state variables and are used in calcResiduals

Implements DAResidual.

Definition at line 96 of file DAResidualHeatTransferFoam.C.

correctBoundaryConditions()

void correctBoundaryConditions ( )

virtual

update the boundary condition for all the states in the selected solver

Implements DAResidual.

Definition at line 105 of file DAResidualHeatTransferFoam.C.

References DAResidualHeatTransferFoam::T_.

Member Data Documentation

T_

volScalarField& T_

protected

Definition at line 33 of file DAResidualHeatTransferFoam.H.

Referenced by DAResidualHeatTransferFoam::calcResiduals(), and DAResidualHeatTransferFoam::correctBoundaryConditions().

TRes_

volScalarField TRes_

protected

Definition at line 34 of file DAResidualHeatTransferFoam.H.

Referenced by DAResidualHeatTransferFoam::calcResiduals(), and DAResidualHeatTransferFoam::clear().

fvSource_

volScalarField& fvSource_

protected

Definition at line 35 of file DAResidualHeatTransferFoam.H.

Referenced by DAResidualHeatTransferFoam::calcResiduals().

kPtr_

autoPtr<dimensionedScalar> kPtr_

protected

Definition at line 38 of file DAResidualHeatTransferFoam.H.

Referenced by DAResidualHeatTransferFoam::calcResiduals(), and DAResidualHeatTransferFoam::DAResidualHeatTransferFoam().

hasFvSource_

label hasFvSource_ = 0

protected

Definition at line 40 of file DAResidualHeatTransferFoam.H.

Referenced by DAResidualHeatTransferFoam::calcResiduals(), and DAResidualHeatTransferFoam::DAResidualHeatTransferFoam().

---

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

• dafoam/src/adjoint/DAResidual/DAResidualHeatTransferFoam.H
• dafoam/src/adjoint/DAResidual/DAResidualHeatTransferFoam.C