Simulation.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#include <optional>
#ifdef USE_PETSC
#include <vtkMPIController.h>
#include <vtkSmartPointer.h>
#endif
 
#include "Applications/ApplicationsLib/LinearSolverLibrarySetup.h"
#include "Applications/ApplicationsLib/TestDefinition.h"
#include "BaseLib/ExportSymbol.h"
 
class ProjectData;
namespace MeshLib
{
class Mesh;
}
 
class Simulation final
{
public:
    OGS_EXPORT_SYMBOL Simulation(int argc, char* argv[]);
 
    OGS_EXPORT_SYMBOL void initializeDataStructures(
        std::string const& project,
        std::vector<std::string> const& xml_patch_file_names,
        bool reference_path_is_set, std::string const& reference_path,
        bool nonfatal, std::string const& outdir, std::string const& mesh_dir,
        std::string const& script_dir, bool write_prj);
 
    OGS_EXPORT_SYMBOL double currentTime() const;
    OGS_EXPORT_SYMBOL double endTime() const;
    OGS_EXPORT_SYMBOL bool executeTimeStep();
    OGS_EXPORT_SYMBOL bool executeSimulation();
    OGS_EXPORT_SYMBOL void outputLastTimeStep() const;
    OGS_EXPORT_SYMBOL MeshLib::Mesh& getMesh(std::string const& name);
    OGS_EXPORT_SYMBOL std::vector<std::string> getMeshNames() const;
 
    OGS_EXPORT_SYMBOL std::optional<ApplicationsLib::TestDefinition>
    getTestDefinition() const;
 
    OGS_EXPORT_SYMBOL ~Simulation();
 
    OGS_EXPORT_SYMBOL static int runTestDefinitions(
        std::optional<ApplicationsLib::TestDefinition>& test_definition);
 
private:
    ApplicationsLib::LinearSolverLibrarySetup linear_solver_library_setup;
#if defined(USE_PETSC)
    vtkSmartPointer<vtkMPIController> controller;
#endif
    std::unique_ptr<ProjectData> project_data;
    std::optional<ApplicationsLib::TestDefinition> test_definition;
#if defined(OGS_USE_INSITU)
    bool isInsituConfigured = false;
#endif
};