DAColoring.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v4
 
    Description:
        Compute the coloring for Jacobian matrices using the parallel
        distance 2 method
 
\*---------------------------------------------------------------------------*/
 
#ifndef DAColoring_H
#define DAColoring_H
 
#include "fvOptions.H"
#include "surfaceFields.H"
#include "DAOption.H"
#include "DAUtility.H"
#include "DAStateInfo.H"
#include "DAModel.H"
#include "DAIndex.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                       Class DAColoring Declaration
\*---------------------------------------------------------------------------*/
 
class DAColoring
{
 
private:
    DAColoring(const DAColoring&);
 
    void operator=(const DAColoring&);
 
protected:
    const fvMesh& mesh_;
 
    const DAOption& daOption_;
 
    const DAIndex& daIndex_;
 
public:
    DAColoring(
        const fvMesh& mesh,
        const DAOption& daOption,
        const DAModel& daModel,
        const DAIndex& daIndex);
 
    virtual ~DAColoring()
    {
    }
 
    // Members
    void getMatNonZeros(
        const Mat conMat,
        label& maxCols,
        scalar& allNonZeros) const;
 
    label find_index(
        const label target,
        const label start,
        const label size,
        const label* valArray) const;
 
    void coloringComplete(
        const Vec colors,
        label& colorCounter,
        label& notColored) const;
 
    void parallelD2Coloring(
        const Mat conMat,
        Vec colors,
        label& nColors) const;
 
    void validateColoring(
        Mat conMat,
        Vec colors) const;
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //