DAFoam: DAResidualTurboFoam Class Reference

Discrete Adjoint with OpenFOAM

Inheritance diagram for DAResidualTurboFoam:

Inheritance graph

[legend]

Collaboration diagram for DAResidualTurboFoam:

Collaboration graph

[legend]

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

volVectorField	URes_

volScalarField &	p_

volScalarField	pRes_

volScalarField &	T_

volScalarField	TRes_

surfaceScalarField &	phi_

surfaceScalarField	phiRes_

fluidThermo &	thermo_
	thermophysical property More...

volVectorField &	URel_
	relative velocity More...

These are intermediate variables
volScalarField &	he_

volScalarField &	rho_

volScalarField &	alphat_

volScalarField &	psi_

DATurbulenceModel &	daTurb_
	DATurbulenceModel object. More...

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

pressureControl	pressureControl_
	pressureControl object to set ref pressure More...

IOMRFZoneListDF &	MRF_
	Multiple Reference Frame. More...

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

These are constants to update the intermediate variables
scalar	molWeight_

scalar	Cp_

	TypeName ("DATurboFoam")

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

virtual	~DAResidualTurboFoam ()

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)

Detailed Description

Definition at line 30 of file DAResidualTurboFoam.H.

Constructor & Destructor Documentation

◆ DAResidualTurboFoam()

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

Definition at line 19 of file DAResidualTurboFoam.C.

References DAResidualTurboFoam::Cp_, DAResidual::daOption_, DAOption::getOption(), mesh, and DAResidualTurboFoam::molWeight_.

Here is the call graph for this function:

◆ ~DAResidualTurboFoam()

virtual ~DAResidualTurboFoam ( )

inlinevirtual

Definition at line 95 of file DAResidualTurboFoam.H.

Member Function Documentation

◆ TypeName()

TypeName ( "DATurboFoam" )

◆ clear()

void clear ( )

virtual

clear the members

Implements DAResidual.

Definition at line 66 of file DAResidualTurboFoam.C.

References DAResidualTurboFoam::phiRes_, DAResidualTurboFoam::pRes_, DAResidualTurboFoam::TRes_, and DAResidualTurboFoam::URes_.

◆ calcResiduals()

void calcResiduals ( const dictionary & options )

virtual

compute residual

Implements DAResidual.

Definition at line 80 of file DAResidualTurboFoam.C.

References adjustPhi(), alphaEff(), DAResidualTurboFoam::alphat_, AtU(), AU(), DAResidual::daOption_, DAResidualTurboFoam::daTurb_, MRFZoneListDF::DDt(), DATurbulenceModel::devRhoReff(), DATurbulenceModel::divDevRhoReff(), EEqn(), DAOption::getOption(), HbyA, DAResidualTurboFoam::he_, MRFZoneListDF::makeRelative(), DAResidual::mesh_, DAResidualTurboFoam::MRF_, normalizePhiResiduals, normalizeResiduals, DAResidualTurboFoam::p_, DAResidualTurboFoam::phi_, phid(), phiHbyA, DAResidualTurboFoam::phiRes_, DAResidualTurboFoam::pRes_, DAResidualTurboFoam::pressureControl_, DAResidualTurboFoam::psi_, rAU(), DAResidualTurboFoam::rho_, DAResidualTurboFoam::simple_, Teff, DAResidualTurboFoam::thermo_, DAResidualTurboFoam::TRes_, tUEqn(), DAResidualTurboFoam::U_, UEqn, DAResidualTurboFoam::URel_, and DAResidualTurboFoam::URes_.

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 233 of file DAResidualTurboFoam.C.

References MRFZoneListDF::correctBoundaryVelocity(), DAResidualTurboFoam::Cp_, DAResidualTurboFoam::he_, DAResidualTurboFoam::molWeight_, DAResidualTurboFoam::MRF_, DAResidualTurboFoam::p_, DAResidualTurboFoam::psi_, DAResidualTurboFoam::rho_, DAResidualTurboFoam::T_, and DAResidualTurboFoam::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 309 of file DAResidualTurboFoam.C.

References DAResidualTurboFoam::p_, DAResidualTurboFoam::T_, and DAResidualTurboFoam::U_.

Member Data Documentation

◆ U_

volVectorField& U_

protected

Definition at line 37 of file DAResidualTurboFoam.H.

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

◆ URes_

volVectorField URes_

protected

Definition at line 38 of file DAResidualTurboFoam.H.

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

◆ p_

volScalarField& p_

protected

Definition at line 40 of file DAResidualTurboFoam.H.

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

◆ pRes_

volScalarField pRes_

protected

Definition at line 41 of file DAResidualTurboFoam.H.

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

◆ T_

volScalarField& T_

protected

Definition at line 43 of file DAResidualTurboFoam.H.

Referenced by DAResidualTurboFoam::correctBoundaryConditions(), and DAResidualTurboFoam::updateIntermediateVariables().

◆ TRes_

volScalarField TRes_

protected

Definition at line 44 of file DAResidualTurboFoam.H.

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

◆ phi_

surfaceScalarField& phi_

protected

Definition at line 46 of file DAResidualTurboFoam.H.

Referenced by DAResidualTurboFoam::calcResiduals().

◆ phiRes_

surfaceScalarField phiRes_

protected

Definition at line 47 of file DAResidualTurboFoam.H.

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

◆ thermo_

fluidThermo& thermo_

protected

thermophysical property

Definition at line 51 of file DAResidualTurboFoam.H.

Referenced by DAResidualTurboFoam::calcResiduals().

◆ URel_

volVectorField& URel_

protected

relative velocity

Definition at line 54 of file DAResidualTurboFoam.H.

Referenced by DAResidualTurboFoam::calcResiduals().

◆ he_

volScalarField& he_

protected

Definition at line 58 of file DAResidualTurboFoam.H.

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

◆ rho_

volScalarField& rho_

protected

Definition at line 59 of file DAResidualTurboFoam.H.

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

◆ alphat_

volScalarField& alphat_

protected

Definition at line 60 of file DAResidualTurboFoam.H.

Referenced by DAResidualTurboFoam::calcResiduals().

◆ psi_

volScalarField& psi_

protected

Definition at line 61 of file DAResidualTurboFoam.H.

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

◆ daTurb_

DATurbulenceModel& daTurb_

protected

DATurbulenceModel object.

Definition at line 65 of file DAResidualTurboFoam.H.

Referenced by DAResidualTurboFoam::calcResiduals().

◆ simple_

simpleControl simple_

protected

simpleControl object which will be initialized in this class

Definition at line 68 of file DAResidualTurboFoam.H.

Referenced by DAResidualTurboFoam::calcResiduals().

◆ pressureControl_

pressureControl pressureControl_

protected

pressureControl object to set ref pressure

Definition at line 71 of file DAResidualTurboFoam.H.

Referenced by DAResidualTurboFoam::calcResiduals().

◆ MRF_

IOMRFZoneListDF& MRF_

protected

Multiple Reference Frame.

Definition at line 74 of file DAResidualTurboFoam.H.

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

◆ molWeight_

scalar molWeight_

protected

Definition at line 78 of file DAResidualTurboFoam.H.

Referenced by DAResidualTurboFoam::DAResidualTurboFoam(), and DAResidualTurboFoam::updateIntermediateVariables().

◆ Cp_

scalar Cp_

protected

Definition at line 79 of file DAResidualTurboFoam.H.

Referenced by DAResidualTurboFoam::DAResidualTurboFoam(), and DAResidualTurboFoam::updateIntermediateVariables().

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

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