DAFoam: DAResidualPimpleFoam Class Reference

Discrete Adjoint with OpenFOAM

Inheritance diagram for DAResidualPimpleFoam:

Inheritance graph

[legend]

Collaboration diagram for DAResidualPimpleFoam:

Collaboration graph

[legend]

These are state variables, state residuals, and partial derivatives
volVectorField &	U_

volVectorField	URes_

volScalarField &	p_

volScalarField	pRes_

surfaceScalarField &	phi_

surfaceScalarField	phiRes_

autoPtr< volScalarField >	TResPtr_

volVectorField &	fvSource_
	fvSource term More...

DATurbulenceModel &	daTurb_
	DATurbulenceModel object. More...

pimpleControl	pimple_
	pimpleControl object which will be initialized in this class More...

label	hasFvSource_ = 0
	whether to has fvSource term More...

label	hasTField_ = 0
	whether to include the temperature field More...

scalar	Pr_

scalar	Prt_

	TypeName ("DAPimpleFoam")

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

virtual	~DAResidualPimpleFoam ()

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...

virtual void	calcPCMatWithFvMatrix (Mat PCMat)
	calculating the adjoint preconditioner matrix using fvMatrix 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...

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 28 of file DAResidualPimpleFoam.H.

Constructor & Destructor Documentation

◆ DAResidualPimpleFoam()

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

Definition at line 19 of file DAResidualPimpleFoam.C.

References allOptions, DAOption::getAllOptions(), DAResidualPimpleFoam::hasFvSource_, DAResidualPimpleFoam::hasTField_, DAUtility::isFieldReadable(), mesh, DAResidualPimpleFoam::Pr_, DAResidualPimpleFoam::Prt_, and DAResidualPimpleFoam::TResPtr_.

Here is the call graph for this function:

◆ ~DAResidualPimpleFoam()

virtual ~DAResidualPimpleFoam ( )

inlinevirtual

Definition at line 78 of file DAResidualPimpleFoam.H.

Member Function Documentation

◆ TypeName()

TypeName ( "DAPimpleFoam" )

◆ clear()

void clear ( )

virtual

clear the members

Implements DAResidual.

Definition at line 76 of file DAResidualPimpleFoam.C.

References DAResidualPimpleFoam::hasTField_, DAResidualPimpleFoam::phiRes_, DAResidualPimpleFoam::pRes_, DAResidualPimpleFoam::TResPtr_, and DAResidualPimpleFoam::URes_.

◆ calcResiduals()

void calcResiduals ( const dictionary & options )

virtual

compute residual

Implements DAResidual.

Definition at line 94 of file DAResidualPimpleFoam.C.

References adjustPhi(), alphaEff(), alphat, DAFvSource::calcFvSource(), DAResidual::daOption_, DAResidualPimpleFoam::daTurb_, DATurbulenceModel::divDevReff(), DAResidualPimpleFoam::fvSource_, DAOption::getOption(), DAResidualPimpleFoam::hasFvSource_, DAResidualPimpleFoam::hasTField_, HbyA, HbyAPtr, DAResidual::mesh_, normalizePhiResiduals, normalizeResiduals, DATurbulenceModel::nu(), DAResidualPimpleFoam::p_, DAResidualPimpleFoam::phi_, phiHbyA, DAResidualPimpleFoam::phiRes_, DAResidualPimpleFoam::pimple_, DAResidualPimpleFoam::Pr_, pRefCell, pRefValue, DAResidualPimpleFoam::pRes_, rAtU(), rAU(), T, TEqn(), DAResidualPimpleFoam::TResPtr_, DAResidualPimpleFoam::U_, UEqn, DAResidualPimpleFoam::URes_, and useConstrainHbyA.

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 497 of file DAResidualPimpleFoam.C.

◆ correctBoundaryConditions()

void correctBoundaryConditions ( )

virtual

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

Implements DAResidual.

Definition at line 507 of file DAResidualPimpleFoam.C.

References DAResidualPimpleFoam::hasTField_, DAResidual::mesh_, DAResidualPimpleFoam::p_, T, and DAResidualPimpleFoam::U_.

◆ calcPCMatWithFvMatrix()

void calcPCMatWithFvMatrix ( Mat PCMat )

virtual

calculating the adjoint preconditioner matrix using fvMatrix

Reimplemented from DAResidual.

Definition at line 229 of file DAResidualPimpleFoam.C.

References adjustPhi(), alphaEff(), alphat, assignValueCheckAD, D, DAResidual::daIndex_, DAResidual::daOption_, DAResidualPimpleFoam::daTurb_, DATurbulenceModel::divDevReff(), forAll(), DAResidualPimpleFoam::fvSource_, DAOption::getAllOptions(), DAIndex::getGlobalAdjointStateIndex(), DAOption::getOption(), DAResidualPimpleFoam::hasTField_, HbyA, HbyAPtr, DAResidual::mesh_, DAIndex::nLocalInternalFaces, DATurbulenceModel::nu(), DAResidualPimpleFoam::p_, DAResidualPimpleFoam::phi_, phiHbyA, DAResidualPimpleFoam::pimple_, DAResidualPimpleFoam::Pr_, pRefCell, pRefValue, rAtU(), rAU(), T, TEqn(), DAResidualPimpleFoam::U_, UEqn, and useConstrainHbyA.

Here is the call graph for this function:

Member Data Documentation

◆ U_

volVectorField& U_

protected

Definition at line 34 of file DAResidualPimpleFoam.H.

Referenced by DAResidualPimpleFoam::calcPCMatWithFvMatrix(), DAResidualPimpleFoam::calcResiduals(), and DAResidualPimpleFoam::correctBoundaryConditions().

◆ URes_

volVectorField URes_

protected

Definition at line 35 of file DAResidualPimpleFoam.H.

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

◆ p_

volScalarField& p_

protected

Definition at line 37 of file DAResidualPimpleFoam.H.

Referenced by DAResidualPimpleFoam::calcPCMatWithFvMatrix(), DAResidualPimpleFoam::calcResiduals(), and DAResidualPimpleFoam::correctBoundaryConditions().

◆ pRes_

volScalarField pRes_

protected

Definition at line 38 of file DAResidualPimpleFoam.H.

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

◆ phi_

surfaceScalarField& phi_

protected

Definition at line 40 of file DAResidualPimpleFoam.H.

Referenced by DAResidualPimpleFoam::calcPCMatWithFvMatrix(), and DAResidualPimpleFoam::calcResiduals().

◆ phiRes_

surfaceScalarField phiRes_

protected

Definition at line 41 of file DAResidualPimpleFoam.H.

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

◆ TResPtr_

autoPtr<volScalarField> TResPtr_

protected

Definition at line 43 of file DAResidualPimpleFoam.H.

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

◆ fvSource_

volVectorField& fvSource_

protected

fvSource term

Definition at line 47 of file DAResidualPimpleFoam.H.

Referenced by DAResidualPimpleFoam::calcPCMatWithFvMatrix(), and DAResidualPimpleFoam::calcResiduals().

◆ daTurb_

DATurbulenceModel& daTurb_

protected

DATurbulenceModel object.

Definition at line 50 of file DAResidualPimpleFoam.H.

Referenced by DAResidualPimpleFoam::calcPCMatWithFvMatrix(), and DAResidualPimpleFoam::calcResiduals().

◆ pimple_

pimpleControl pimple_

protected

pimpleControl object which will be initialized in this class

Definition at line 53 of file DAResidualPimpleFoam.H.

Referenced by DAResidualPimpleFoam::calcPCMatWithFvMatrix(), and DAResidualPimpleFoam::calcResiduals().

◆ hasFvSource_

label hasFvSource_ = 0

protected

whether to has fvSource term

Definition at line 56 of file DAResidualPimpleFoam.H.

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

◆ hasTField_

label hasTField_ = 0

protected

whether to include the temperature field

Definition at line 59 of file DAResidualPimpleFoam.H.

Referenced by DAResidualPimpleFoam::calcPCMatWithFvMatrix(), DAResidualPimpleFoam::calcResiduals(), DAResidualPimpleFoam::clear(), DAResidualPimpleFoam::correctBoundaryConditions(), and DAResidualPimpleFoam::DAResidualPimpleFoam().

◆ Pr_

scalar Pr_

protected

Definition at line 61 of file DAResidualPimpleFoam.H.

Referenced by DAResidualPimpleFoam::calcPCMatWithFvMatrix(), DAResidualPimpleFoam::calcResiduals(), and DAResidualPimpleFoam::DAResidualPimpleFoam().

◆ Prt_

scalar Prt_

protected

Definition at line 63 of file DAResidualPimpleFoam.H.

Referenced by DAResidualPimpleFoam::DAResidualPimpleFoam().

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

dafoam/src/adjoint/DAResidual/DAResidualPimpleFoam.H
dafoam/src/adjoint/DAResidual/DAResidualPimpleFoam.C