Simulation Class Reference

Detailed Description

Definition at line 20 of file Simulation.h.

#include <Simulation.h>

Public Member Functions
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 ()

Static Public Member Functions
static OGS_EXPORT_SYMBOL int	runTestDefinitions (std::optional< ApplicationsLib::TestDefinition > &test_definition)

Private Attributes
std::shared_ptr< ApplicationsLib::LinearSolverLibrarySetup >	linear_solver_library_setup
vtkSmartPointer< vtkMPIController >	controller
std::unique_ptr< ProjectData >	project_data
std::optional< ApplicationsLib::TestDefinition >	test_definition
bool	isInsituConfigured = false

Constructor & Destructor Documentation

Simulation()

Simulation::Simulation	(	int	argc,
		char *	argv[] )

Definition at line 22 of file Simulation.cpp.

    : linear_solver_library_setup{ApplicationsLib::LinearSolverLibrarySetup::
                                      create(argc, argv)},
#if defined(USE_PETSC)
      controller(vtkSmartPointer<vtkMPIController>::New()),
#endif
      test_definition{std::nullopt}
{
#if defined(USE_PETSC)
    controller->Initialize(&argc, &argv, 1);
    vtkMPIController::SetGlobalController(controller);
#endif
}

References controller, linear_solver_library_setup, and test_definition.

~Simulation()

Simulation::~Simulation

(

)

Definition at line 180 of file Simulation.cpp.

{
#ifdef OGS_USE_INSITU
    if (isInsituConfigured)
    {
        InSituLib::Finalize();
    }
#endif
#if defined(USE_PETSC)
    controller->Finalize(1);
#endif
}

References controller, InSituLib::Finalize(), and isInsituConfigured.

Member Function Documentation

currentTime()

double Simulation::currentTime

(

)

const

Definition at line 111 of file Simulation.cpp.

{
    auto const& time_loop = project_data->getTimeLoop();
    return time_loop.currentTime()();
}

References project_data.

endTime()

double Simulation::endTime

(

)

const

Definition at line 117 of file Simulation.cpp.

{
    auto const& time_loop = project_data->getTimeLoop();
    return time_loop.endTime()();
}

References project_data.

executeSimulation()

bool Simulation::executeSimulation

(

)

Definition at line 152 of file Simulation.cpp.

{
    INFO("Solve processes.");
    auto& time_loop = project_data->getTimeLoop();
    while (time_loop.currentTime() < time_loop.endTime())
    {
        time_loop.executeTimeStep();
        if (!time_loop.calculateNextTimeStep())
        {
            break;
        }
    }
 
    return time_loop.successful_time_step;
}

References INFO(), and project_data.

Referenced by main().

executeTimeStep()

bool Simulation::executeTimeStep

(

)

Definition at line 123 of file Simulation.cpp.

{
    auto& time_loop = project_data->getTimeLoop();
    if (time_loop.currentTime() < time_loop.endTime())
    {
        auto const result = time_loop.executeTimeStep();
        time_loop.calculateNextTimeStep();
        return result;
    }
    return false;
}

References project_data.

getMesh()

MeshLib::Mesh & Simulation::getMesh

(

std::string const &

name

)

Definition at line 135 of file Simulation.cpp.

{
    return project_data->getMesh(name);
}

References project_data.

getMeshNames()

std::vector< std::string > Simulation::getMeshNames

(

)

const

Definition at line 140 of file Simulation.cpp.

{
    return project_data->getMeshNames();
}

References project_data.

getTestDefinition()

std::optional< ApplicationsLib::TestDefinition > Simulation::getTestDefinition

(

)

const

Definition at line 174 of file Simulation.cpp.

{
    return test_definition;
}

References test_definition.

Referenced by main().

initializeDataStructures()

void Simulation::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 )

Input File Parameter

prj__test_definition

Input File Parameter

prj__insitu

Input File Parameter

prj__insitu__scripts

Definition at line 36 of file Simulation.cpp.

{
    INFO("Reading project file {}.",
         std::filesystem::relative(project).string());
    DBUG("Project file: {}.", std::filesystem::absolute(project).string());
    DBUG("Working directory: {}.", std::filesystem::current_path().string());
 
    std::stringstream prj_stream;
    BaseLib::prepareProjectFile(prj_stream, project, xml_patch_file_names,
                                write_prj, outdir);
    auto project_config = BaseLib::makeConfigTree(
        project, !nonfatal, "OpenGeoSysProject", prj_stream);
 
    if (!reference_path_is_set)
    {  // Ignore the test_definition section.
        project_config.ignoreConfigParameter("test_definition");
    }
    else
    {
        test_definition = ApplicationsLib::TestDefinition(
            project_config.getConfigSubtree("test_definition"), reference_path,
            outdir);
        if (test_definition->numberOfTests() == 0)
        {
            OGS_FATAL(
                "No tests were constructed from the test definitions, "
                "but reference solutions path was given.");
        }
 
        INFO("Cleanup possible output files before running ogs.");
        BaseLib::removeFiles(test_definition->getOutputFiles());
    }
#ifdef OGS_USE_INSITU
    if (auto t = project_config.getConfigSubtreeOptional("insitu"))
    {
        InSituLib::Initialize(
            t->getConfigSubtree("scripts"),
            BaseLib::extractPath(project));
        isInsituConfigured = true;
    }
#else
    project_config.ignoreConfigParameter("insitu");
#endif
 
    project_data = std::make_unique<ProjectData>(project_config, outdir,
                                                 mesh_dir, script_dir);
 
    INFO("Initialize processes.");
    for (auto& p : project_data->getProcesses())
    {
        p->initialize(project_data->getMedia());
    }
 
    // Check intermediately that config parsing went fine.
    checkAndInvalidate(project_config);
    BaseLib::ConfigTree::assertNoSwallowedErrors();
 
    auto& time_loop = project_data->getTimeLoop();
    auto time_value = time_loop.currentTime()();
    INFO("Time step #0 started. Time: {}. Step size: 0.", time_value);
 
    BaseLib::RunTime init_timer;
    init_timer.start();
    time_loop.initialize();
    INFO("Time step #0 took {:g} s.", init_timer.elapsed());
}

References BaseLib::ConfigTree::assertNoSwallowedErrors(), DBUG(), BaseLib::RunTime::elapsed(), BaseLib::extractPath(), INFO(), InSituLib::Initialize(), isInsituConfigured, BaseLib::makeConfigTree(), OGS_FATAL, BaseLib::prepareProjectFile(), project_data, BaseLib::removeFiles(), BaseLib::RunTime::start(), and test_definition.

Referenced by main().

outputLastTimeStep()

void Simulation::outputLastTimeStep

(

)

const

Definition at line 168 of file Simulation.cpp.

{
    auto const& time_loop = project_data->getTimeLoop();
    time_loop.outputLastTimeStep();
}

References project_data.

Referenced by main().

runTestDefinitions()

int Simulation::runTestDefinitions ( std::optional< ApplicationsLib::TestDefinition > & test_definition )

static

Definition at line 193 of file Simulation.cpp.

{
    // In serial builds, run the complete test definition normally. In PETSc
    // builds, xdmfdiff tests compare global XDMF/HDF5 output files and must run
    // only once on rank 0 after all ranks have finished simulation.
    // The rank 0 result is broadcast so every rank exits with the same status.
    if (!test_definition)
    {
        auto const end_time = std::chrono::system_clock::now();
        auto const time_str = BaseLib::formatDate(end_time);
        DBUG("No test definition was found. No tests will be executed.");
        INFO("OGS completed on {:s}.", time_str);
        return EXIT_SUCCESS;
    }
 
#if defined(USE_PETSC)
    bool const has_xdmfdiff_tests = test_definition->hasTests("xdmfdiff");
    BaseLib::MPI::Mpi mpi;
    bool const run_all_tests = !has_xdmfdiff_tests;
    bool const run_xdmfdiff_tests = has_xdmfdiff_tests && mpi.rank == 0;
#else
    bool constexpr run_all_tests = true;
    bool constexpr run_xdmfdiff_tests = false;
#endif
 
    auto const log_tests_header = []
    {
        INFO("");
        INFO("##########################################");
        INFO("# Running tests                          #");
        INFO("##########################################");
        INFO("");
    };
 
    auto tests_succeeded = true;
    if (run_all_tests)
    {
        log_tests_header();
        tests_succeeded = test_definition->runTests();
    }
    else
    {
        tests_succeeded = test_definition->runTestsExcluding("xdmfdiff");
    }
 
#if defined(USE_PETSC)
    if (has_xdmfdiff_tests)
    {
        // Need to wait until all ranks have written their output.
        MPI_Barrier(mpi.communicator);
        auto xdmfdiff_status = EXIT_SUCCESS;
        if (run_xdmfdiff_tests)
        {
            log_tests_header();
            xdmfdiff_status = test_definition->runTests("xdmfdiff")
                                  ? EXIT_SUCCESS
                                  : EXIT_FAILURE;
        }
        MPI_Bcast(&xdmfdiff_status, 1, MPI_INT, 0, mpi.communicator);
 
        tests_succeeded = tests_succeeded && xdmfdiff_status == EXIT_SUCCESS;
        tests_succeeded = BaseLib::MPI::allOf(tests_succeeded, mpi);
    }
#endif
 
    if (run_all_tests || run_xdmfdiff_tests)
    {
        auto const end_time = std::chrono::system_clock::now();
        auto const time_str = BaseLib::formatDate(end_time);
        if (tests_succeeded)
        {
            INFO("OGS completed on {:s}.", time_str);
        }
        else
        {
            ERR("OGS terminated on {:s}. One of the tests failed.", time_str);
        }
    }
    return tests_succeeded ? EXIT_SUCCESS : EXIT_FAILURE;
}

References BaseLib::MPI::allOf(), BaseLib::MPI::Mpi::communicator, DBUG(), ERR(), BaseLib::formatDate(), INFO(), BaseLib::MPI::Mpi::rank, and test_definition.

Referenced by OGSSimulation::finalize(), and main().

Member Data Documentation

controller

vtkSmartPointer<vtkMPIController> Simulation::controller

private

Definition at line 52 of file Simulation.h.

Referenced by Simulation(), and ~Simulation().

isInsituConfigured

bool Simulation::isInsituConfigured = false

private

Definition at line 57 of file Simulation.h.

Referenced by ~Simulation(), and initializeDataStructures().

linear_solver_library_setup

std::shared_ptr<ApplicationsLib::LinearSolverLibrarySetup> Simulation::linear_solver_library_setup

private

Definition at line 50 of file Simulation.h.

Referenced by Simulation().

project_data

std::unique_ptr<ProjectData> Simulation::project_data

private

Definition at line 54 of file Simulation.h.

Referenced by currentTime(), endTime(), executeSimulation(), executeTimeStep(), getMesh(), getMeshNames(), initializeDataStructures(), and outputLastTimeStep().

test_definition

std::optional<ApplicationsLib::TestDefinition> Simulation::test_definition

private

Definition at line 55 of file Simulation.h.

Referenced by Simulation(), getTestDefinition(), initializeDataStructures(), and runTestDefinitions().

---

The documentation for this class was generated from the following files:

• Simulation.h
• Simulation.cpp