DAResidualRhoPimpleFoam Class Reference

Inheritance diagram for DAResidualRhoPimpleFoam:

Collaboration diagram for DAResidualRhoPimpleFoam:

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...
fluidThermo &	thermo_
	thermophysical property More...
These are intermediate variables
volScalarField &	he_
volScalarField &	rho_
volScalarField &	alphat_
volScalarField &	psi_
volScalarField &	dpdt_
volScalarField &	K_
DATurbulenceModel &	daTurb_
	DATurbulenceModel object. More...
pimpleControl	pimple_
	pimpleControl object which will be initialized in this class 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 ("DARhoPimpleFoam")
	DAResidualRhoPimpleFoam (const word modelType, const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex)
virtual	~DAResidualRhoPimpleFoam ()
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)

Detailed Description

Definition at line 31 of file DAResidualRhoPimpleFoam.H.

Constructor & Destructor Documentation

DAResidualRhoPimpleFoam()

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

Definition at line 19 of file DAResidualRhoPimpleFoam.C.

References allOptions, DAResidualRhoPimpleFoam::Cp_, DAResidual::daOption_, DAOption::getAllOptions(), DAOption::getOption(), DAResidualRhoPimpleFoam::hasFvSource_, mesh, and DAResidualRhoPimpleFoam::molWeight_.

Here is the call graph for this function:

~DAResidualRhoPimpleFoam()

virtual ~DAResidualRhoPimpleFoam ( )

inlinevirtual

Definition at line 98 of file DAResidualRhoPimpleFoam.H.

Member Function Documentation

TypeName()

TypeName

(

"DARhoPimpleFoam"

)

clear()

void clear ( )

virtual

clear the members

Implements DAResidual.

Definition at line 76 of file DAResidualRhoPimpleFoam.C.

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

calcResiduals()

void calcResiduals ( const dictionary &  options )

virtual

compute residual

Implements DAResidual.

Definition at line 90 of file DAResidualRhoPimpleFoam.C.

References alphaEff(), DAResidualRhoPimpleFoam::alphat_, DAFvSource::calcFvSource(), DAResidual::daOption_, DAResidualRhoPimpleFoam::daTurb_, DATurbulenceModel::divDevRhoReff(), DAResidualRhoPimpleFoam::dpdt_, EEqn(), DAResidualRhoPimpleFoam::fvSource_, DAResidualRhoPimpleFoam::fvSourceEnergy_, DAOption::getOption(), DAResidualRhoPimpleFoam::hasFvSource_, HbyA, HbyAPtr, DAResidualRhoPimpleFoam::he_, DAResidualRhoPimpleFoam::K_, DAResidual::mesh_, normalizePhiResiduals, normalizeResiduals, DAResidualRhoPimpleFoam::p_, DAResidualRhoPimpleFoam::phi_, phiHbyA, DAResidualRhoPimpleFoam::phiRes_, DAResidualRhoPimpleFoam::pRes_, DAResidualRhoPimpleFoam::psi_, rAU(), DAResidualRhoPimpleFoam::rho_, rhorAUf(), DAResidualRhoPimpleFoam::thermo_, DAResidualRhoPimpleFoam::TRes_, tUEqn(), DAResidualRhoPimpleFoam::U_, UEqn, DAResidualRhoPimpleFoam::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 212 of file DAResidualRhoPimpleFoam.C.

References DAResidualRhoPimpleFoam::Cp_, DAResidualRhoPimpleFoam::dpdt_, DAResidualRhoPimpleFoam::he_, DAResidualRhoPimpleFoam::K_, DAResidualRhoPimpleFoam::molWeight_, DAResidualRhoPimpleFoam::p_, DAResidualRhoPimpleFoam::psi_, DAResidualRhoPimpleFoam::rho_, DAResidualRhoPimpleFoam::T_, and DAResidualRhoPimpleFoam::U_.

correctBoundaryConditions()

void correctBoundaryConditions ( )

virtual

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

Implements DAResidual.

Definition at line 300 of file DAResidualRhoPimpleFoam.C.

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

calcPCMatWithFvMatrix()

void calcPCMatWithFvMatrix ( Mat  PCMat )

virtual

calculating the adjoint preconditioner matrix using fvMatrix

Reimplemented from DAResidual.

Definition at line 312 of file DAResidualRhoPimpleFoam.C.

References assignValueCheckAD, DAFvSource::calcFvSource(), D, DAResidual::daIndex_, DAResidual::daOption_, DAResidualRhoPimpleFoam::daTurb_, DATurbulenceModel::divDevRhoReff(), forAll(), DAResidualRhoPimpleFoam::fvSource_, DAResidualRhoPimpleFoam::fvSourceEnergy_, DAOption::getAllOptions(), DAIndex::getGlobalAdjointStateIndex(), DAOption::getOption(), DAResidualRhoPimpleFoam::hasFvSource_, HbyA, HbyAPtr, DAResidual::mesh_, DAIndex::nLocalInternalFaces, DAResidualRhoPimpleFoam::p_, DAResidualRhoPimpleFoam::phi_, phiHbyA, DAResidualRhoPimpleFoam::psi_, rAU(), DAResidualRhoPimpleFoam::rho_, rhorAUf(), DAResidualRhoPimpleFoam::U_, UEqn, and useConstrainHbyA.

Here is the call graph for this function:

Member Data Documentation

U_

volVectorField& U_

protected

Definition at line 38 of file DAResidualRhoPimpleFoam.H.

Referenced by DAResidualRhoPimpleFoam::calcPCMatWithFvMatrix(), DAResidualRhoPimpleFoam::calcResiduals(), DAResidualRhoPimpleFoam::correctBoundaryConditions(), and DAResidualRhoPimpleFoam::updateIntermediateVariables().

URes_

volVectorField URes_

protected

Definition at line 39 of file DAResidualRhoPimpleFoam.H.

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

p_

volScalarField& p_

protected

Definition at line 41 of file DAResidualRhoPimpleFoam.H.

Referenced by DAResidualRhoPimpleFoam::calcPCMatWithFvMatrix(), DAResidualRhoPimpleFoam::calcResiduals(), DAResidualRhoPimpleFoam::correctBoundaryConditions(), and DAResidualRhoPimpleFoam::updateIntermediateVariables().

pRes_

volScalarField pRes_

protected

Definition at line 42 of file DAResidualRhoPimpleFoam.H.

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

T_

volScalarField& T_

protected

Definition at line 44 of file DAResidualRhoPimpleFoam.H.

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

TRes_

volScalarField TRes_

protected

Definition at line 45 of file DAResidualRhoPimpleFoam.H.

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

phi_

surfaceScalarField& phi_

protected

Definition at line 47 of file DAResidualRhoPimpleFoam.H.

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

phiRes_

surfaceScalarField phiRes_

protected

Definition at line 48 of file DAResidualRhoPimpleFoam.H.

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

fvSource_

volVectorField& fvSource_

protected

fvSource term

Definition at line 52 of file DAResidualRhoPimpleFoam.H.

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

fvSourceEnergy_

volScalarField& fvSourceEnergy_

protected

fvSource term for the energy equation

Definition at line 55 of file DAResidualRhoPimpleFoam.H.

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

thermo_

fluidThermo& thermo_

protected

thermophysical property

Definition at line 58 of file DAResidualRhoPimpleFoam.H.

Referenced by DAResidualRhoPimpleFoam::calcResiduals().

he_

volScalarField& he_

protected

Definition at line 62 of file DAResidualRhoPimpleFoam.H.

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

rho_

volScalarField& rho_

protected

Definition at line 63 of file DAResidualRhoPimpleFoam.H.

Referenced by DAResidualRhoPimpleFoam::calcPCMatWithFvMatrix(), DAResidualRhoPimpleFoam::calcResiduals(), and DAResidualRhoPimpleFoam::updateIntermediateVariables().

alphat_

volScalarField& alphat_

protected

Definition at line 64 of file DAResidualRhoPimpleFoam.H.

Referenced by DAResidualRhoPimpleFoam::calcResiduals().

psi_

volScalarField& psi_

protected

Definition at line 65 of file DAResidualRhoPimpleFoam.H.

Referenced by DAResidualRhoPimpleFoam::calcPCMatWithFvMatrix(), DAResidualRhoPimpleFoam::calcResiduals(), and DAResidualRhoPimpleFoam::updateIntermediateVariables().

dpdt_

volScalarField& dpdt_

protected

Definition at line 66 of file DAResidualRhoPimpleFoam.H.

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

K_

volScalarField& K_

protected

Definition at line 67 of file DAResidualRhoPimpleFoam.H.

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

daTurb_

DATurbulenceModel& daTurb_

protected

DATurbulenceModel object.

Definition at line 71 of file DAResidualRhoPimpleFoam.H.

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

pimple_

pimpleControl pimple_

protected

pimpleControl object which will be initialized in this class

Definition at line 74 of file DAResidualRhoPimpleFoam.H.

molWeight_

scalar molWeight_

protected

Definition at line 78 of file DAResidualRhoPimpleFoam.H.

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

Cp_

scalar Cp_

protected

Definition at line 79 of file DAResidualRhoPimpleFoam.H.

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

hasFvSource_

label hasFvSource_ = 0

protected

whether to have fvSource term

Definition at line 83 of file DAResidualRhoPimpleFoam.H.

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

---

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

• dafoam/src/adjoint/DAResidual/DAResidualRhoPimpleFoam.H
• dafoam/src/adjoint/DAResidual/DAResidualRhoPimpleFoam.C