DAFoam: DAResidualRhoSimpleFoam Class Reference

Discrete Adjoint with OpenFOAM

Inheritance diagram for DAResidualRhoSimpleFoam:

Inheritance graph

[legend]

Collaboration diagram for DAResidualRhoSimpleFoam:

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_

volVectorField &	fvSource_
	fvSource term More...

volScalarField &	fvSourceEnergy_
	fvSource term for the energy equation More...

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

fluidThermo &	thermo_
	thermophysical property 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_

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

	TypeName ("DARhoSimpleFoam")

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

virtual	~DAResidualRhoSimpleFoam ()

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

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 31 of file DAResidualRhoSimpleFoam.H.

Constructor & Destructor Documentation

◆ DAResidualRhoSimpleFoam()

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

Definition at line 19 of file DAResidualRhoSimpleFoam.C.

References allOptions, DAResidualRhoSimpleFoam::Cp_, daOption(), DAResidual::daOption_, DAResidualRhoSimpleFoam::fvOptions_, DAOption::getOption(), DAResidualRhoSimpleFoam::hasFvSource_, mesh, DAResidualRhoSimpleFoam::molWeight_, DAResidualRhoSimpleFoam::phi_, DAResidualRhoSimpleFoam::rho_, DAResidualRhoSimpleFoam::U_, and UEqn.

Here is the call graph for this function:

◆ ~DAResidualRhoSimpleFoam()

virtual ~DAResidualRhoSimpleFoam ( )

inlinevirtual

Definition at line 105 of file DAResidualRhoSimpleFoam.H.

Member Function Documentation

◆ TypeName()

TypeName ( "DARhoSimpleFoam" )

◆ clear()

void clear ( )

virtual

clear the members

Implements DAResidual.

Definition at line 83 of file DAResidualRhoSimpleFoam.C.

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

◆ calcResiduals()

void calcResiduals ( const dictionary & options )

virtual

compute residual

Implements DAResidual.

Definition at line 97 of file DAResidualRhoSimpleFoam.C.

References adjustPhi(), alphaEff(), DAResidualRhoSimpleFoam::alphat_, DAFvSource::calcFvSource(), constrainPressure(), DAResidualRhoSimpleFoam::daTurb_, MRFZoneListDF::DDt(), DATurbulenceModel::divDevRhoReff(), EEqn(), DAResidualRhoSimpleFoam::fvOptions_, DAResidualRhoSimpleFoam::fvSource_, DAResidualRhoSimpleFoam::fvSourceEnergy_, DAResidualRhoSimpleFoam::hasFvSource_, HbyA, DAResidualRhoSimpleFoam::he_, MRFZoneListDF::makeRelative(), DAResidual::mesh_, DAResidualRhoSimpleFoam::MRF_, normalizePhiResiduals, normalizeResiduals, DAResidualRhoSimpleFoam::p_, DAResidualRhoSimpleFoam::phi_, phiHbyA, DAResidualRhoSimpleFoam::phiRes_, DAResidualRhoSimpleFoam::pRes_, DAResidualRhoSimpleFoam::pressureControl_, DAResidualRhoSimpleFoam::psi_, rAU(), DAResidualRhoSimpleFoam::rho_, rhorAUf(), DAResidualRhoSimpleFoam::thermo_, DAResidualRhoSimpleFoam::TRes_, tUEqn(), DAResidualRhoSimpleFoam::U_, UEqn, and DAResidualRhoSimpleFoam::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 217 of file DAResidualRhoSimpleFoam.C.

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

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

Member Data Documentation

◆ U_

volVectorField& U_

protected

Definition at line 38 of file DAResidualRhoSimpleFoam.H.

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

◆ URes_

volVectorField URes_

protected

Definition at line 39 of file DAResidualRhoSimpleFoam.H.

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

◆ p_

volScalarField& p_

protected

Definition at line 41 of file DAResidualRhoSimpleFoam.H.

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

◆ pRes_

volScalarField pRes_

protected

Definition at line 42 of file DAResidualRhoSimpleFoam.H.

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

◆ T_

volScalarField& T_

protected

Definition at line 44 of file DAResidualRhoSimpleFoam.H.

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

◆ TRes_

volScalarField TRes_

protected

Definition at line 45 of file DAResidualRhoSimpleFoam.H.

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

◆ phi_

surfaceScalarField& phi_

protected

Definition at line 47 of file DAResidualRhoSimpleFoam.H.

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

◆ phiRes_

surfaceScalarField phiRes_

protected

Definition at line 48 of file DAResidualRhoSimpleFoam.H.

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

◆ fvSource_

volVectorField& fvSource_

protected

fvSource term

Definition at line 52 of file DAResidualRhoSimpleFoam.H.

Referenced by DAResidualRhoSimpleFoam::calcResiduals().

◆ fvSourceEnergy_

volScalarField& fvSourceEnergy_

protected

fvSource term for the energy equation

Definition at line 55 of file DAResidualRhoSimpleFoam.H.

Referenced by DAResidualRhoSimpleFoam::calcResiduals().

◆ fvOptions_

fv::options& fvOptions_

protected

fvOptions term

Definition at line 58 of file DAResidualRhoSimpleFoam.H.

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

◆ thermo_

fluidThermo& thermo_

protected

thermophysical property

Definition at line 61 of file DAResidualRhoSimpleFoam.H.

Referenced by DAResidualRhoSimpleFoam::calcResiduals().

◆ he_

volScalarField& he_

protected

Definition at line 65 of file DAResidualRhoSimpleFoam.H.

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

◆ rho_

volScalarField& rho_

protected

Definition at line 66 of file DAResidualRhoSimpleFoam.H.

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

◆ alphat_

volScalarField& alphat_

protected

Definition at line 67 of file DAResidualRhoSimpleFoam.H.

Referenced by DAResidualRhoSimpleFoam::calcResiduals().

◆ psi_

volScalarField& psi_

protected

Definition at line 68 of file DAResidualRhoSimpleFoam.H.

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

◆ daTurb_

DATurbulenceModel& daTurb_

protected

DATurbulenceModel object.

Definition at line 72 of file DAResidualRhoSimpleFoam.H.

Referenced by DAResidualRhoSimpleFoam::calcResiduals().

◆ simple_

simpleControl simple_

protected

simpleControl object which will be initialized in this class

Definition at line 75 of file DAResidualRhoSimpleFoam.H.

◆ pressureControl_

pressureControl pressureControl_

protected

pressureControl object to set ref pressure

Definition at line 78 of file DAResidualRhoSimpleFoam.H.

Referenced by DAResidualRhoSimpleFoam::calcResiduals().

◆ MRF_

IOMRFZoneListDF& MRF_

protected

Multiple Reference Frame.

Definition at line 81 of file DAResidualRhoSimpleFoam.H.

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

◆ molWeight_

scalar molWeight_

protected

Definition at line 85 of file DAResidualRhoSimpleFoam.H.

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

◆ Cp_

scalar Cp_

protected

Definition at line 86 of file DAResidualRhoSimpleFoam.H.

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

◆ hasFvSource_

label hasFvSource_ = 0

protected

whether to have fvSource term

Definition at line 90 of file DAResidualRhoSimpleFoam.H.

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

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

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