Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
DAResidual Class Referenceabstract
Inheritance diagram for DAResidual:
Inheritance graph
[legend]
Collaboration diagram for DAResidual:
Collaboration graph
[legend]

Public Member Functions

 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 ()
 
virtual void clear ()=0
 clear the members More...
 
virtual void calcResiduals (const dictionary &options)=0
 compute residuals More...
 
virtual void updateIntermediateVariables ()=0
 update any intermdiate variables that are dependent on state variables and are used in calcResiduals More...
 
virtual void correctBoundaryConditions ()=0
 update the boundary condition for all the states in the selected solver More...
 
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

static autoPtr< DAResidual > New (const word modelType, const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex)
 

Protected Attributes

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 36 of file DAResidual.H.

Constructor & Destructor Documentation

◆ DAResidual()

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

Definition at line 22 of file DAResidual.C.

◆ ~DAResidual()

virtual ~DAResidual ( )
inlinevirtual

Definition at line 100 of file DAResidual.H.

Member Function Documentation

◆ TypeName()

TypeName ( "DAResidual"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
DAResidual  ,
dictionary  ,
(const word modelType, const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex)  ,
(modelType, mesh, daOption, daModel, daIndex)   
)

◆ New()

autoPtr< DAResidual > New ( const word  modelType,
const fvMesh &  mesh,
const DAOption &  daOption,
const DAModel &  daModel,
const DAIndex &  daIndex 
)
static

Definition at line 47 of file DAResidual.C.

References DAOption::getAllOptions(), and mesh.

Here is the call graph for this function:

◆ clear()

virtual void clear ( )
pure virtual

clear the members

Implemented in DAResidualRhoSimpleFoam, DAResidualRhoPimpleFoam, DAResidualTurboFoam, DAResidualRhoSimpleCFoam, DAResidualSimpleFoam, DAResidualPimpleDyMFoam, DAResidualPimpleFoam, DAResidualHeatTransferFoam, and DAResidualSolidDisplacementFoam.

◆ calcResiduals()

virtual void calcResiduals ( const dictionary &  options)
pure virtual

compute residuals

Implemented in DAResidualRhoSimpleFoam, DAResidualRhoPimpleFoam, DAResidualTurboFoam, DAResidualRhoSimpleCFoam, DAResidualSimpleFoam, DAResidualPimpleDyMFoam, DAResidualPimpleFoam, DAResidualHeatTransferFoam, and DAResidualSolidDisplacementFoam.

Referenced by DAFunctionResidualNorm::calcFunction(), DAResidual::masterFunction(), and DAOutputResidual::run().

Here is the caller graph for this function:

◆ updateIntermediateVariables()

virtual void updateIntermediateVariables ( )
pure virtual

update any intermdiate variables that are dependent on state variables and are used in calcResiduals

Implemented in DAResidualRhoSimpleFoam, DAResidualRhoPimpleFoam, DAResidualTurboFoam, DAResidualRhoSimpleCFoam, DAResidualSimpleFoam, DAResidualPimpleDyMFoam, DAResidualPimpleFoam, DAResidualHeatTransferFoam, and DAResidualSolidDisplacementFoam.

Referenced by DAResidual::masterFunction().

Here is the caller graph for this function:

◆ correctBoundaryConditions()

virtual void correctBoundaryConditions ( )
pure virtual

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

Implemented in DAResidualRhoSimpleFoam, DAResidualRhoPimpleFoam, DAResidualTurboFoam, DAResidualRhoSimpleCFoam, DAResidualSimpleFoam, DAResidualPimpleDyMFoam, DAResidualPimpleFoam, DAResidualHeatTransferFoam, and DAResidualSolidDisplacementFoam.

Referenced by DAResidual::masterFunction().

Here is the caller graph for this function:

◆ masterFunction()

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

Definition at line 90 of file DAResidual.C.

References DAModel::calcResiduals(), DAResidual::calcResiduals(), DAModel::correctBoundaryConditions(), DAResidual::correctBoundaryConditions(), DAResidual::daField_, DAResidual::daModel_, DAField::ofResField2ResVec(), DAField::specialBCTreatment(), DAField::stateVec2OFField(), DAModel::updateIntermediateVariables(), and DAResidual::updateIntermediateVariables().

Referenced by DAPartDeriv::calcPartDerivMat().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ calcPCMatWithFvMatrix()

void calcPCMatWithFvMatrix ( Mat  PCMat)
virtual

calculating the adjoint preconditioner matrix using fvMatrix

Reimplemented in DAResidualRhoPimpleFoam, DAResidualPimpleDyMFoam, and DAResidualPimpleFoam.

Definition at line 169 of file DAResidual.C.

◆ writeData()

bool writeData ( Ostream &  os) const
inline

virtual function for regIOobject

Definition at line 129 of file DAResidual.H.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_
protected

fvMesh

Definition at line 49 of file DAResidual.H.

Referenced by DAResidualPimpleDyMFoam::calcPCMatWithFvMatrix(), DAResidualPimpleFoam::calcPCMatWithFvMatrix(), DAResidualRhoPimpleFoam::calcPCMatWithFvMatrix(), DAResidualHeatTransferFoam::calcResiduals(), DAResidualPimpleFoam::calcResiduals(), DAResidualPimpleDyMFoam::calcResiduals(), DAResidualSimpleFoam::calcResiduals(), DAResidualRhoSimpleCFoam::calcResiduals(), DAResidualTurboFoam::calcResiduals(), DAResidualRhoPimpleFoam::calcResiduals(), DAResidualRhoSimpleFoam::calcResiduals(), DAResidualPimpleFoam::correctBoundaryConditions(), DAResidualPimpleDyMFoam::correctBoundaryConditions(), DAResidualSimpleFoam::correctBoundaryConditions(), and DAResidualHeatTransferFoam::DAResidualHeatTransferFoam().

◆ daOption_

const DAOption& daOption_
protected

DAOption object.

Definition at line 52 of file DAResidual.H.

Referenced by DAResidualPimpleDyMFoam::calcPCMatWithFvMatrix(), DAResidualPimpleFoam::calcPCMatWithFvMatrix(), DAResidualRhoPimpleFoam::calcPCMatWithFvMatrix(), DAResidualPimpleDyMFoam::calcResiduals(), DAResidualPimpleFoam::calcResiduals(), DAResidualSimpleFoam::calcResiduals(), DAResidualRhoSimpleCFoam::calcResiduals(), DAResidualTurboFoam::calcResiduals(), DAResidualRhoPimpleFoam::calcResiduals(), DAResidualRhoSimpleFoam::calcResiduals(), DAResidualRhoPimpleFoam::DAResidualRhoPimpleFoam(), DAResidualRhoSimpleCFoam::DAResidualRhoSimpleCFoam(), DAResidualRhoSimpleFoam::DAResidualRhoSimpleFoam(), and DAResidualTurboFoam::DAResidualTurboFoam().

◆ daModel_

const DAModel& daModel_
protected

DAModel object.

Definition at line 55 of file DAResidual.H.

Referenced by DAResidual::masterFunction().

◆ daIndex_

const DAIndex& daIndex_
protected

DAIndex.

Definition at line 58 of file DAResidual.H.

Referenced by DAResidualPimpleDyMFoam::calcPCMatWithFvMatrix(), DAResidualPimpleFoam::calcPCMatWithFvMatrix(), and DAResidualRhoPimpleFoam::calcPCMatWithFvMatrix().

◆ daField_

DAField daField_
protected

DAField object.

Definition at line 61 of file DAResidual.H.

Referenced by DAResidual::masterFunction().

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

Generated by   doxygen 1.8.17