/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2021     Equinor ASA
//
//  ResInsight is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  ResInsight is distributed in the hope that it will be useful, but WITHOUT ANY
//  WARRANTY; without even the implied warranty of MERCHANTABILITY or
//  FITNESS FOR A PARTICULAR PURPOSE.
//
//  See the GNU General Public License at <http://www.gnu.org/licenses/gpl.html>
//  for more details.
//
/////////////////////////////////////////////////////////////////////////////////

#pragma once

#include "RiaDefines.h"

#include "cvfStructGrid.h"

#include <list>
#include <set>

#include <QString>

class RigCell;
class RimStreamline;
class RigMainGrid;
class RigGridBase;
class RigResultAccessor;
class RigEclipseCaseData;
class RimStreamlineDataAccess;

class RimStreamlineGeneratorBase
{
public:
    RimStreamlineGeneratorBase( std::set<size_t>& wellCells );
    ~RimStreamlineGeneratorBase();

    void setLimits( double flowThreshold, int maxDays, double resolutionInDays, double minimumLength );

    void initGenerator( RimStreamlineDataAccess* dataAccess, std::list<RiaDefines::PhaseType> phases );

    virtual void generateTracer( RigCell cell, double direction, QString simWellName, std::list<RimStreamline*>& outStreamlines ) = 0;

protected:
    double m_flowThreshold;
    int    m_maxDays;
    double m_resolution;
    double m_minLength;

    size_t m_maxPoints;

    std::set<size_t> m_visitedCells;

    std::set<size_t>& m_wellCells;

    RimStreamlineDataAccess*         m_dataAccess;
    std::list<RiaDefines::PhaseType> m_phases;

    const std::list<cvf::StructGridInterface::FaceType> m_allFaces = { cvf::StructGridInterface::FaceType::POS_I,
                                                                       cvf::StructGridInterface::FaceType::NEG_I,
                                                                       cvf::StructGridInterface::FaceType::POS_J,
                                                                       cvf::StructGridInterface::FaceType::NEG_J,
                                                                       cvf::StructGridInterface::FaceType::POS_K,
                                                                       cvf::StructGridInterface::FaceType::NEG_K };
};