DAFoam: DAResidualSimpleFoam Class Reference

Discrete Adjoint with OpenFOAM

Inheritance diagram for DAResidualSimpleFoam:

Inheritance graph

[legend]

Collaboration diagram for DAResidualSimpleFoam:

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_

volScalarField &	alphaPorosity_
	alpha porosity term More...

volVectorField &	fvSource_
	fvSource term More...

fv::options &	fvOptions_
	fvOptions term More...

DATurbulenceModel &	daTurb_
	DATurbulenceModel object. More...

simpleControl	simple_
	simpleControl object which will be initialized in this class More...

IOMRFZoneListDF &	MRF_
	Multiple Reference Frame. More...

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

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

scalar	Pr_

scalar	Prt_

	TypeName ("DASimpleFoam")

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

virtual	~DAResidualSimpleFoam ()

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 29 of file DAResidualSimpleFoam.H.

Constructor & Destructor Documentation

◆ DAResidualSimpleFoam()

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

Definition at line 19 of file DAResidualSimpleFoam.C.

References allOptions, DAResidualSimpleFoam::fvOptions_, DAOption::getAllOptions(), DAResidualSimpleFoam::hasFvSource_, DAResidualSimpleFoam::hasTField_, DAUtility::isFieldReadable(), mesh, DAResidualSimpleFoam::phi_, DAResidualSimpleFoam::Pr_, DAResidualSimpleFoam::Prt_, DAResidualSimpleFoam::TResPtr_, DAResidualSimpleFoam::U_, and UEqn.

Here is the call graph for this function:

◆ ~DAResidualSimpleFoam()

virtual ~DAResidualSimpleFoam ( )

inlinevirtual

Definition at line 88 of file DAResidualSimpleFoam.H.

Member Function Documentation

◆ TypeName()

TypeName ( "DASimpleFoam" )

◆ clear()

void clear ( )

virtual

clear the members

Implements DAResidual.

Definition at line 89 of file DAResidualSimpleFoam.C.

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

◆ calcResiduals()

void calcResiduals ( const dictionary & options )

virtual

compute residual

Implements DAResidual.

Definition at line 106 of file DAResidualSimpleFoam.C.

References adjustPhi(), alphaEff(), DAResidualSimpleFoam::alphaPorosity_, alphat, DAFvSource::calcFvSource(), constrainPressure(), DAResidual::daOption_, DAResidualSimpleFoam::daTurb_, MRFZoneListDF::DDt(), DATurbulenceModel::divDevReff(), DAResidualSimpleFoam::fvOptions_, DAResidualSimpleFoam::fvSource_, DAOption::getOption(), DAResidualSimpleFoam::hasFvSource_, DAResidualSimpleFoam::hasTField_, HbyA, HbyAPtr, MRFZoneListDF::makeRelative(), DAResidual::mesh_, DAResidualSimpleFoam::MRF_, normalizePhiResiduals, normalizeResiduals, DATurbulenceModel::nu(), DAResidualSimpleFoam::p_, DAResidualSimpleFoam::phi_, phiHbyA, DAResidualSimpleFoam::phiRes_, DAResidualSimpleFoam::Pr_, pRefCell, pRefValue, DAResidualSimpleFoam::pRes_, rAtU(), rAU(), DAResidualSimpleFoam::simple_, T, TEqn(), DAResidualSimpleFoam::TResPtr_, tUEqn(), DAResidualSimpleFoam::U_, UEqn, DAResidualSimpleFoam::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 239 of file DAResidualSimpleFoam.C.

References MRFZoneListDF::correctBoundaryVelocity(), DAResidualSimpleFoam::fvOptions_, DAResidualSimpleFoam::MRF_, and DAResidualSimpleFoam::U_.

Here is the call graph for this function:

◆ correctBoundaryConditions()

void correctBoundaryConditions ( )

virtual

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

Implements DAResidual.

Definition at line 250 of file DAResidualSimpleFoam.C.

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

Member Data Documentation

◆ U_

volVectorField& U_

protected

Definition at line 35 of file DAResidualSimpleFoam.H.

Referenced by DAResidualSimpleFoam::calcResiduals(), DAResidualSimpleFoam::correctBoundaryConditions(), DAResidualSimpleFoam::DAResidualSimpleFoam(), and DAResidualSimpleFoam::updateIntermediateVariables().

◆ URes_

volVectorField URes_

protected

Definition at line 36 of file DAResidualSimpleFoam.H.

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

◆ p_

volScalarField& p_

protected

Definition at line 38 of file DAResidualSimpleFoam.H.

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

◆ pRes_

volScalarField pRes_

protected

Definition at line 39 of file DAResidualSimpleFoam.H.

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

◆ phi_

surfaceScalarField& phi_

protected

Definition at line 41 of file DAResidualSimpleFoam.H.

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

◆ phiRes_

surfaceScalarField phiRes_

protected

Definition at line 42 of file DAResidualSimpleFoam.H.

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

◆ TResPtr_

autoPtr<volScalarField> TResPtr_

protected

Definition at line 44 of file DAResidualSimpleFoam.H.

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

◆ alphaPorosity_

volScalarField& alphaPorosity_

protected

alpha porosity term

Definition at line 48 of file DAResidualSimpleFoam.H.

Referenced by DAResidualSimpleFoam::calcResiduals().

◆ fvSource_

volVectorField& fvSource_

protected

fvSource term

Definition at line 51 of file DAResidualSimpleFoam.H.

Referenced by DAResidualSimpleFoam::calcResiduals().

◆ fvOptions_

fv::options& fvOptions_

protected

fvOptions term

Definition at line 54 of file DAResidualSimpleFoam.H.

Referenced by DAResidualSimpleFoam::calcResiduals(), DAResidualSimpleFoam::DAResidualSimpleFoam(), and DAResidualSimpleFoam::updateIntermediateVariables().

◆ daTurb_

DATurbulenceModel& daTurb_

protected

DATurbulenceModel object.

Definition at line 57 of file DAResidualSimpleFoam.H.

Referenced by DAResidualSimpleFoam::calcResiduals().

◆ simple_

simpleControl simple_

protected

simpleControl object which will be initialized in this class

Definition at line 60 of file DAResidualSimpleFoam.H.

Referenced by DAResidualSimpleFoam::calcResiduals().

◆ MRF_

IOMRFZoneListDF& MRF_

protected

Multiple Reference Frame.

Definition at line 63 of file DAResidualSimpleFoam.H.

Referenced by DAResidualSimpleFoam::calcResiduals(), and DAResidualSimpleFoam::updateIntermediateVariables().

◆ hasFvSource_

label hasFvSource_ = 0

protected

whether to have fvSource term

Definition at line 66 of file DAResidualSimpleFoam.H.

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

◆ hasTField_

label hasTField_ = 0

protected

whether to include the temperature field

Definition at line 69 of file DAResidualSimpleFoam.H.

Referenced by DAResidualSimpleFoam::calcResiduals(), DAResidualSimpleFoam::clear(), DAResidualSimpleFoam::correctBoundaryConditions(), and DAResidualSimpleFoam::DAResidualSimpleFoam().

◆ Pr_

scalar Pr_

protected

Definition at line 71 of file DAResidualSimpleFoam.H.

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

◆ Prt_

scalar Prt_

protected

Definition at line 73 of file DAResidualSimpleFoam.H.

Referenced by DAResidualSimpleFoam::DAResidualSimpleFoam().

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

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