DAFoam: DAResidualRhoSimpleCFoam Class Reference

Discrete Adjoint with OpenFOAM

Inheritance diagram for DAResidualRhoSimpleCFoam:

Inheritance graph

[legend]

Collaboration diagram for DAResidualRhoSimpleCFoam:

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

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

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 ("DARhoSimpleCFoam")

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

virtual	~DAResidualRhoSimpleCFoam ()

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

Constructor & Destructor Documentation

◆ DAResidualRhoSimpleCFoam()

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

Definition at line 19 of file DAResidualRhoSimpleCFoam.C.

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

Here is the call graph for this function:

◆ ~DAResidualRhoSimpleCFoam()

virtual ~DAResidualRhoSimpleCFoam ( )

inlinevirtual

Definition at line 89 of file DAResidualRhoSimpleCFoam.H.

Member Function Documentation

◆ TypeName()

TypeName ( "DARhoSimpleCFoam" )

◆ clear()

void clear ( )

virtual

clear the members

Implements DAResidual.

Definition at line 62 of file DAResidualRhoSimpleCFoam.C.

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

◆ calcResiduals()

void calcResiduals ( const dictionary & options )

virtual

compute residual

Implements DAResidual.

Definition at line 76 of file DAResidualRhoSimpleCFoam.C.

References alphaEff(), DAResidualRhoSimpleCFoam::alphat_, DAResidual::daOption_, DAResidualRhoSimpleCFoam::daTurb_, DATurbulenceModel::divDevRhoReff(), EEqn(), DAOption::getOption(), HbyA, HbyAPtr, DAResidualRhoSimpleCFoam::he_, DAResidual::mesh_, normalizePhiResiduals, normalizeResiduals, DAResidualRhoSimpleCFoam::p_, DAResidualRhoSimpleCFoam::phi_, phid(), phiHbyA, DAResidualRhoSimpleCFoam::phiRes_, DAResidualRhoSimpleCFoam::pRes_, DAResidualRhoSimpleCFoam::pressureControl_, DAResidualRhoSimpleCFoam::psi_, rAtU(), rAU(), DAResidualRhoSimpleCFoam::rho_, rhorAtU(), DAResidualRhoSimpleCFoam::thermo_, DAResidualRhoSimpleCFoam::TRes_, tUEqn(), DAResidualRhoSimpleCFoam::U_, UEqn, DAResidualRhoSimpleCFoam::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 206 of file DAResidualRhoSimpleCFoam.C.

References DAResidualRhoSimpleCFoam::Cp_, DAResidualRhoSimpleCFoam::he_, DAResidualRhoSimpleCFoam::molWeight_, DAResidualRhoSimpleCFoam::p_, DAResidualRhoSimpleCFoam::psi_, DAResidualRhoSimpleCFoam::rho_, and DAResidualRhoSimpleCFoam::T_.

◆ correctBoundaryConditions()

void correctBoundaryConditions ( )

virtual

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

Implements DAResidual.

Definition at line 280 of file DAResidualRhoSimpleCFoam.C.

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

Member Data Documentation

◆ U_

volVectorField& U_

protected

Definition at line 37 of file DAResidualRhoSimpleCFoam.H.

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

◆ URes_

volVectorField URes_

protected

Definition at line 38 of file DAResidualRhoSimpleCFoam.H.

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

◆ p_

volScalarField& p_

protected

Definition at line 40 of file DAResidualRhoSimpleCFoam.H.

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

◆ pRes_

volScalarField pRes_

protected

Definition at line 41 of file DAResidualRhoSimpleCFoam.H.

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

◆ T_

volScalarField& T_

protected

Definition at line 43 of file DAResidualRhoSimpleCFoam.H.

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

◆ TRes_

volScalarField TRes_

protected

Definition at line 44 of file DAResidualRhoSimpleCFoam.H.

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

◆ phi_

surfaceScalarField& phi_

protected

Definition at line 46 of file DAResidualRhoSimpleCFoam.H.

Referenced by DAResidualRhoSimpleCFoam::calcResiduals().

◆ phiRes_

surfaceScalarField phiRes_

protected

Definition at line 47 of file DAResidualRhoSimpleCFoam.H.

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

◆ thermo_

fluidThermo& thermo_

protected

thermophysical property

Definition at line 51 of file DAResidualRhoSimpleCFoam.H.

Referenced by DAResidualRhoSimpleCFoam::calcResiduals().

◆ he_

volScalarField& he_

protected

Definition at line 55 of file DAResidualRhoSimpleCFoam.H.

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

◆ rho_

volScalarField& rho_

protected

Definition at line 56 of file DAResidualRhoSimpleCFoam.H.

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

◆ alphat_

volScalarField& alphat_

protected

Definition at line 57 of file DAResidualRhoSimpleCFoam.H.

Referenced by DAResidualRhoSimpleCFoam::calcResiduals().

◆ psi_

volScalarField& psi_

protected

Definition at line 58 of file DAResidualRhoSimpleCFoam.H.

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

◆ daTurb_

DATurbulenceModel& daTurb_

protected

DATurbulenceModel object.

Definition at line 62 of file DAResidualRhoSimpleCFoam.H.

Referenced by DAResidualRhoSimpleCFoam::calcResiduals().

◆ simple_

simpleControl simple_

protected

simpleControl object which will be initialized in this class

Definition at line 65 of file DAResidualRhoSimpleCFoam.H.

◆ pressureControl_

pressureControl pressureControl_

protected

pressureControl object to set ref pressure

Definition at line 68 of file DAResidualRhoSimpleCFoam.H.

Referenced by DAResidualRhoSimpleCFoam::calcResiduals().

◆ molWeight_

scalar molWeight_

protected

Definition at line 72 of file DAResidualRhoSimpleCFoam.H.

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

◆ Cp_

scalar Cp_

protected

Definition at line 73 of file DAResidualRhoSimpleCFoam.H.

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

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

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