DAIndex.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v3
 
    Description:
        Handel state indexing in serial and in parallel
 
\*---------------------------------------------------------------------------*/
 
#ifndef DAIndex_H
#define DAIndex_H
 
#include "fvOptions.H"
#include "surfaceFields.H"
#include "DAOption.H"
#include "DAUtility.H"
#include "DAStateInfo.H"
#include "DAModel.H"
#include "globalIndex.H"
#include "DAMacroFunctions.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                       Class DAIndex Declaration
\*---------------------------------------------------------------------------*/
 
class DAIndex
{
 
private:
    DAIndex(const DAIndex&);
 
    void operator=(const DAIndex&);
 
protected:
    const fvMesh& mesh_;
 
    const DAOption& daOption_;
 
    const DAModel& daModel_;
 
    HashTable<wordList> stateInfo_;
 
    void writeAdjointIndexing();
 
public:
    DAIndex(
        const fvMesh& mesh,
        const DAOption& daOption,
        const DAModel& daModel);
 
    virtual ~DAIndex()
    {
    }
 
    // Members
 
    // adjoint indexing info
    List<word> adjStateNames;
 
    HashTable<word> adjStateType;
 
    // mesh sizes
    // local sizes
 
    label nLocalCells;
 
    label nLocalFaces;
 
    label nLocalPoints;
 
    label nLocalXv;
 
    label nLocalBoundaryFaces;
 
    label nLocalInternalFaces;
 
    label nLocalBoundaryPatches;
 
    label nLocalCoupledBFaces;
 
    labelList bFacePatchI;
 
    labelList bFaceFaceI;
 
    HashTable<label> stateLocalIndexOffset;
 
    HashTable<label> adjStateID;
 
    // glocal sizes
    label nGlobalCells;
 
    label nGlobalFaces;
 
    label nGlobalXv;
 
    label nGlobalObjFuncFaces;
 
    label nGlobalCoupledBFaces;
 
    // adjoint sizes
    label nLocalAdjointStates;
 
    label nGlobalAdjointStates;
 
    label nLocalAdjointBoundaryStates;
 
    label nVolScalarStates;
 
    label nVolVectorStates;
 
    label nSurfaceScalarStates;
 
    label nModelStates;
 
 
    globalIndex globalAdjointStateNumbering;
    globalIndex globalCellNumbering;
    globalIndex globalCellVectorNumbering; // similar to globalCellNumbering but has 3 components per cell
    globalIndex globalFaceNumbering;
    globalIndex globalCoupledBFaceNumbering;
    globalIndex globalObjFuncGeoNumbering;
    globalIndex globalXvNumbering;
    globalIndex globalVolScalarFieldNumbering;
    globalIndex globalVolVectorFieldNumbering;
    globalIndex globalSurfaceScalarFieldNumbering;
 
    labelIOList pointProcAddressing;
 
    label nUndecomposedPoints;
 
    labelList isCoupledFace;
 
    wordList adjStateName4LocalAdjIdx;
 
    scalarList cellIFaceI4LocalAdjIdx;
 
    labelList faceOwner;
 
    labelList phiAccumulatdOffset;
 
    labelList phiLocalOffset;
 
    // Member functions
 
    void calcStateLocalIndexOffset(HashTable<label>& offset);
 
    void calcAdjStateID(HashTable<label>& adjStateID);
 
    void calcLocalIdxLists(
        wordList& adjStateName4LocalAdjIdx,
        scalarList& cellIFaceI4LocalAdjIdx);
 
    label getLocalAdjointStateIndex(
        const word stateName,
        const label idxI,
        const label comp = -1) const;
 
    label getGlobalAdjointStateIndex(
        const word stateName,
        const label idxI,
        const label comp = -1) const;
 
    label getGlobalXvIndex(
        const label idxPoint,
        const label idxCoord) const;
 
    label getLocalXvIndex(
        const label idxPoint,
        const label idxCoord) const;
 
    label getLocalCellIndex(const label cellI) const;
 
    label getGlobalCellIndex(const label cellI) const;
 
    label getLocalCellVectorIndex(
        const label cellI,
        const label comp) const;
 
    label getGlobalCellVectorIndex(
        const label cellI,
        const label comp) const;
 
    label getLocalFaceIndex(const label faceI) const;
 
    label getGlobalFaceIndex(const label faceI) const;
 
    void calcAdjStateID4GlobalAdjIdx(labelList& adjStateID4GlobalAdjIdx) const;
 
    void printIndices() const
    {
        //Info<<"adjStateNames"<<adjStateNames<<endl;
        Info << "Adjoint States: " << adjStateType << endl;
 
        // Print relevant sizes to screen
        Info << "Global Cells: " << nGlobalCells << endl;
        Info << "Global Faces: " << nGlobalFaces << endl;
        Info << "Global Xv: " << nGlobalXv << endl;
        Info << "Undecomposed points: " << nUndecomposedPoints << endl;
        Info << "Global Adjoint States: " << nGlobalAdjointStates << endl;
    }
 
    void printMatChars(const Mat matIn) const;
 
    void getMatNonZeros(
        const Mat matIn,
        label& maxCols,
        scalar& allNonZeros) const;
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //