Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
DAPartDeriv Class Reference
Collaboration diagram for DAPartDeriv:
Collaboration graph
[legend]

Public Member Functions

 DAPartDeriv (const word modelType, const fvMesh &mesh, const DAOption &daOption, const DAModel &daModel, const DAIndex &daIndex, const DAJacCon &daJacCon, const DAResidual &daResidual)
 
virtual ~DAPartDeriv ()
 
void clear ()
 clear members in parent and child objects More...
 
void initializePartDerivMat (const dictionary &options, Mat jacMat)
 initialize partial derivative matrix More...
 
void calcPartDerivMat (const dictionary &options, const Vec xvVec, const Vec wVec, Mat jacMat)
 compute the partial derivative matrix More...
 
void setNormStatePerturbVec (Vec *normStatePerturbVec)
 setup the state normalization vector More...
 

Protected Member Functions

void perturbStates (const Vec jacConColors, const Vec normStatePerturbVec, const label colorI, const scalar delta, Vec wVec)
 perturb state variables given a color index More...
 
void setPartDerivMat (const Vec resVec, const Vec coloredColumn, const label transposed, Mat jacMat, const scalar jacLowerBound=1e-30) const
 set values for the partial derivative matrix More...
 

Protected Attributes

const word modelType_
 the name of the jacCon matrix More...
 
const fvMesh & mesh_
 fvMesh More...
 
const DAOption & daOption_
 DAOption object. More...
 
const DAModel & daModel_
 DAModel object. More...
 
const DAIndex & daIndex_
 DAIndex object. More...
 
const DAJacCon & daJacCon_
 DAJacCon object. More...
 
const DAResidual & daResidual_
 DAResidual object. More...
 
const dictionary & allOptions_
 all the DAFoam option More...
 
HashTable< wordList > stateInfo_
 the stateInfo_ list from DAStateInfo object More...
 

Detailed Description

Definition at line 35 of file DAPartDeriv.H.

Constructor & Destructor Documentation

◆ DAPartDeriv()

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

Definition at line 17 of file DAPartDeriv.C.

References DAOption::getOption(), mesh, DAStateInfo::New(), solverName, and DAPartDeriv::stateInfo_.

Here is the call graph for this function:

◆ ~DAPartDeriv()

virtual ~DAPartDeriv ( )
inlinevirtual

Definition at line 101 of file DAPartDeriv.H.

Member Function Documentation

◆ perturbStates()

void perturbStates ( const Vec  jacConColors,
const Vec  normStatePerturbVec,
const label  colorI,
const scalar  delta,
Vec  wVec 
)
protected

perturb state variables given a color index

Definition at line 42 of file DAPartDeriv.C.

References assignValueCheckAD.

Referenced by DAPartDeriv::calcPartDerivMat().

Here is the caller graph for this function:

◆ setPartDerivMat()

void setPartDerivMat ( const Vec  resVec,
const Vec  coloredColumn,
const label  transposed,
Mat  jacMat,
const scalar  jacLowerBound = 1e-30 
) const
protected

set values for the partial derivative matrix

Definition at line 109 of file DAPartDeriv.C.

Referenced by DAPartDeriv::calcPartDerivMat().

Here is the caller graph for this function:

◆ clear()

void clear ( )
inline

clear members in parent and child objects

Definition at line 108 of file DAPartDeriv.H.

◆ initializePartDerivMat()

void initializePartDerivMat ( const dictionary &  options,
Mat  jacMat 
)

initialize partial derivative matrix

Definition at line 317 of file DAPartDeriv.C.

References DAPartDeriv::daIndex_, DAPartDeriv::daJacCon_, DAPartDeriv::mesh_, DAIndex::nLocalAdjointStates, and DAJacCon::preallocatedRdW().

Referenced by DASolver::calcdRdWT().

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

◆ calcPartDerivMat()

void calcPartDerivMat ( const dictionary &  options,
const Vec  xvVec,
const Vec  wVec,
Mat  jacMat 
)

compute the partial derivative matrix

Definition at line 350 of file DAPartDeriv.C.

References assignValueCheckAD, DAJacCon::calcColoredColumns(), DAPartDeriv::daIndex_, DAPartDeriv::daJacCon_, DAPartDeriv::daOption_, DAPartDeriv::daResidual_, DAJacCon::getJacConColor(), DAJacCon::getNJacConColors(), DAOption::getOption(), DAOption::getSubDictOption(), DAResidual::masterFunction(), DAPartDeriv::mesh_, DAPartDeriv::modelType_, DAPartDeriv::perturbStates(), DAIndex::printMatChars(), DAPartDeriv::setNormStatePerturbVec(), and DAPartDeriv::setPartDerivMat().

Referenced by DASolver::calcdRdWT().

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

◆ setNormStatePerturbVec()

void setNormStatePerturbVec ( Vec *  normStatePerturbVec)

setup the state normalization vector

Definition at line 210 of file DAPartDeriv.C.

References DAPartDeriv::allOptions_, assignValueCheckAD, DAIndex::bFaceFaceI, DAIndex::bFacePatchI, DAPartDeriv::daIndex_, forAll(), DAIndex::getGlobalAdjointStateIndex(), DAPartDeriv::mesh_, DAIndex::nLocalAdjointStates, DAIndex::nLocalInternalFaces, and DAPartDeriv::stateInfo_.

Referenced by DAPartDeriv::calcPartDerivMat().

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

Member Data Documentation

◆ modelType_

const word modelType_
protected

the name of the jacCon matrix

Definition at line 47 of file DAPartDeriv.H.

Referenced by DAPartDeriv::calcPartDerivMat().

◆ mesh_

const fvMesh& mesh_
protected

fvMesh

Definition at line 50 of file DAPartDeriv.H.

Referenced by DAPartDeriv::calcPartDerivMat(), DAPartDeriv::initializePartDerivMat(), and DAPartDeriv::setNormStatePerturbVec().

◆ daOption_

const DAOption& daOption_
protected

DAOption object.

Definition at line 53 of file DAPartDeriv.H.

Referenced by DAPartDeriv::calcPartDerivMat().

◆ daModel_

const DAModel& daModel_
protected

DAModel object.

Definition at line 56 of file DAPartDeriv.H.

◆ daIndex_

const DAIndex& daIndex_
protected

DAIndex object.

Definition at line 59 of file DAPartDeriv.H.

Referenced by DAPartDeriv::calcPartDerivMat(), DAPartDeriv::initializePartDerivMat(), and DAPartDeriv::setNormStatePerturbVec().

◆ daJacCon_

const DAJacCon& daJacCon_
protected

DAJacCon object.

Definition at line 62 of file DAPartDeriv.H.

Referenced by DAPartDeriv::calcPartDerivMat(), and DAPartDeriv::initializePartDerivMat().

◆ daResidual_

const DAResidual& daResidual_
protected

DAResidual object.

Definition at line 65 of file DAPartDeriv.H.

Referenced by DAPartDeriv::calcPartDerivMat().

◆ allOptions_

const dictionary& allOptions_
protected

all the DAFoam option

Definition at line 68 of file DAPartDeriv.H.

Referenced by DAPartDeriv::setNormStatePerturbVec().

◆ stateInfo_

HashTable<wordList> stateInfo_
protected

the stateInfo_ list from DAStateInfo object

Definition at line 71 of file DAPartDeriv.H.

Referenced by DAPartDeriv::DAPartDeriv(), and DAPartDeriv::setNormStatePerturbVec().

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

Generated by   doxygen 1.8.17