ResInsight/ApplicationLibCode/GeoMech/OdbReader/RifGeoMechReaderInterface.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2015-     Statoil ASA
//  Copyright (C) 2015-     Ceetron Solutions AS
//
//  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 "cvfObject.h"
#include "cvfVector3.h"

#include <map>
#include <string>
#include <vector>

class RigFemPartCollection;

//==================================================================================================
//
// Data interface base class
//
//==================================================================================================
class RifGeoMechReaderInterface : public cvf::Object
{
public:
    RifGeoMechReaderInterface();
    ~RifGeoMechReaderInterface() override;

    virtual bool                     openFile( const std::string& fileName, std::string* errorMessage ) = 0;
    virtual bool                     isOpen() const                                                     = 0;
    virtual bool                     readFemParts( RigFemPartCollection* geoMechCase )                  = 0;
    virtual std::vector<std::string> allStepNames() const                                               = 0;
    virtual std::vector<std::string> filteredStepNames() const                                          = 0;
    virtual std::vector<double>      frameTimes( int stepIndex ) const                                  = 0;
    virtual int                      frameCount( int stepIndex ) const                                  = 0;

    virtual std::vector<std::string> elementSetNames( int partIndex, std::string partName )          = 0;
    virtual std::vector<size_t>      elementSet( int partIndex, std::string partName, int setIndex ) = 0;

    virtual std::map<std::string, std::vector<std::string>> scalarNodeFieldAndComponentNames()             = 0;
    virtual std::map<std::string, std::vector<std::string>> scalarElementNodeFieldAndComponentNames()      = 0;
    virtual std::map<std::string, std::vector<std::string>> scalarIntegrationPointFieldAndComponentNames() = 0;

    virtual void readDisplacements( int partIndex, int stepIndex, int frameIndex, std::vector<cvf::Vec3f>* displacements ) = 0;

    virtual void readNodeField( const std::string&                fieldName,
                                int                               partIndex,
                                int                               stepIndex,
                                int                               frameIndex,
                                std::vector<std::vector<float>*>* resultValues )             = 0;
    virtual void readElementNodeField( const std::string&                fieldName,
                                       int                               partIndex,
                                       int                               stepIndex,
                                       int                               frameIndex,
                                       std::vector<std::vector<float>*>* resultValues )      = 0;
    virtual void readIntegrationPointField( const std::string&                fieldName,
                                            int                               partIndex,
                                            int                               stepIndex,
                                            int                               frameIndex,
                                            std::vector<std::vector<float>*>* resultValues ) = 0;

    void setTimeStepFilter( const std::vector<size_t>& fileTimeStepIndices, bool readOnlyLastFrame );
    bool isTimeStepIncludedByFilter( int timeStepIndex ) const;
    int  timeStepIndexOnFile( int timeStepIndex ) const;
    int  frameIndexOnFile( int frameIndex ) const;

    bool shouldReadOnlyLastFrame() const;

private:
    std::vector<int> m_fileTimeStepIndices;
    bool             m_readOnlyLastFrame;
};