DAFoam: DAOutput Class Reference

Discrete Adjoint with OpenFOAM

Inheritance diagram for DAOutput:

Inheritance graph

[legend]

Collaboration diagram for DAOutput:

Collaboration graph

[legend]

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

	declareRunTimeSelectionTable (autoPtr, DAOutput, dictionary,(const word outputName, const word outputType, fvMesh &mesh, const DAOption &daOption, DAModel &daModel, const DAIndex &daIndex, DAResidual &daResidual, UPtrList< DAFunction > &daFunctionList),(outputName, outputType, mesh, daOption, daModel, daIndex, daResidual, daFunctionList))

	DAOutput (const word outputName, const word outputType, fvMesh &mesh, const DAOption &daOption, DAModel &daModel, const DAIndex &daIndex, DAResidual &daResidual, UPtrList< DAFunction > &daFunctionList)

virtual	~DAOutput ()

virtual void	run (scalarList &output)=0

virtual label	size ()=0

virtual label	distributed ()=0

Static Public Member Functions
static autoPtr< DAOutput >	New (const word outputName, const word outputType, fvMesh &mesh, const DAOption &daOption, DAModel &daModel, const DAIndex &daIndex, DAResidual &daResidual, UPtrList< DAFunction > &daFunctionList)

Protected Attributes
const word	outputName_
	name of the output More...

const word	outputType_
	type of the output More...

fvMesh &	mesh_
	fvMesh More...

const DAOption &	daOption_
	DAOption object. More...

DAModel &	daModel_
	DAIndex object. More...

const DAIndex &	daIndex_
	DAIndex object. More...

DAResidual &	daResidual_

UPtrList< DAFunction > &	daFunctionList_

HashTable< wordList >	stateInfo_
	the stateInfo_ list from DAStateInfo object More...

Detailed Description

Definition at line 32 of file DAOutput.H.

Constructor & Destructor Documentation

◆ DAOutput()

DAOutput	(	const word	outputName,
		const word	outputType,
		fvMesh &	mesh,
		const DAOption &	daOption,
		DAModel &	daModel,
		const DAIndex &	daIndex,
		DAResidual &	daResidual,
		UPtrList< DAFunction > &	daFunctionList
	)

Definition at line 22 of file DAOutput.C.

References DAOutput::daOption_, DAOption::getOption(), mesh, DAStateInfo::New(), solverName, and DAOutput::stateInfo_.

Here is the call graph for this function:

◆ ~DAOutput()

virtual ~DAOutput ( )

inlinevirtual

Definition at line 123 of file DAOutput.H.

Member Function Documentation

◆ TypeName()

TypeName ( "DAOutput" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		DAOutput	,
		dictionary	,
		(const word outputName, const word outputType, fvMesh &mesh, const DAOption &daOption, DAModel &daModel, const DAIndex &daIndex, DAResidual &daResidual, UPtrList< DAFunction > &daFunctionList)	,
		(outputName, outputType, mesh, daOption, daModel, daIndex, daResidual, daFunctionList)
	)

◆ New()

autoPtr< DAOutput > New	(	const word	outputName,
		const word	outputType,
		fvMesh &	mesh,
		const DAOption &	daOption,
		DAModel &	daModel,
		const DAIndex &	daIndex,
		DAResidual &	daResidual,
		UPtrList< DAFunction > &	daFunctionList
	)

static

Definition at line 48 of file DAOutput.C.

References DAOption::getAllOptions(), and mesh.

Referenced by DASolver::calcJacTVecProduct(), DASolver::calcOutput(), DASolver::getOutputDistributed(), and DASolver::getOutputSize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

virtual void run ( scalarList & output )

pure virtual

Implemented in DAOutputThermalCoupling, DAOutputFunction, DAOutputForceCoupling, and DAOutputResidual.

◆ size()

virtual label size ( )

pure virtual

Implemented in DAOutputThermalCoupling, DAOutputFunction, DAOutputForceCoupling, and DAOutputResidual.

◆ distributed()

virtual label distributed ( )

pure virtual

Implemented in DAOutputThermalCoupling, DAOutputFunction, DAOutputForceCoupling, and DAOutputResidual.

Member Data Documentation

◆ outputName_

const word outputName_

protected

name of the output

Definition at line 44 of file DAOutput.H.

Referenced by DAOutputForceCoupling::DAOutputForceCoupling(), DAOutputThermalCoupling::DAOutputThermalCoupling(), and DAOutputFunction::run().

◆ outputType_

const word outputType_

protected

type of the output

Definition at line 47 of file DAOutput.H.

◆ mesh_

fvMesh& mesh_

protected

fvMesh

Definition at line 50 of file DAOutput.H.

Referenced by DAOutputForceCoupling::DAOutputForceCoupling(), DAOutputThermalCoupling::DAOutputThermalCoupling(), DAOutputResidual::run(), DAOutputForceCoupling::run(), and DAOutputThermalCoupling::run().

◆ daOption_

const DAOption& daOption_

protected

DAOption object.

Definition at line 53 of file DAOutput.H.

Referenced by DAOutput::DAOutput(), DAOutputForceCoupling::DAOutputForceCoupling(), and DAOutputThermalCoupling::DAOutputThermalCoupling().

◆ daModel_

DAModel& daModel_

protected

DAIndex object.

Definition at line 56 of file DAOutput.H.

Referenced by DAOutputResidual::run(), DAOutputForceCoupling::run(), and DAOutputThermalCoupling::run().

◆ daIndex_

const DAIndex& daIndex_

protected

DAIndex object.

Definition at line 59 of file DAOutput.H.

Referenced by DAOutputResidual::run(), and DAOutputResidual::size().

◆ daResidual_

DAResidual& daResidual_

protected

Definition at line 61 of file DAOutput.H.

Referenced by DAOutputResidual::run().

◆ daFunctionList_

UPtrList<DAFunction>& daFunctionList_

protected

Definition at line 63 of file DAOutput.H.

Referenced by DAOutputFunction::run().

◆ stateInfo_

HashTable<wordList> stateInfo_

protected

the stateInfo_ list from DAStateInfo object

Definition at line 66 of file DAOutput.H.

Referenced by DAOutput::DAOutput(), and DAOutputResidual::run().

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

dafoam/src/adjoint/DAOutput/DAOutput.H
dafoam/src/adjoint/DAOutput/DAOutput.C