Simulation Class Reference

#include <simulation.hpp>

Collaboration diagram for Simulation:

Public Member Functions
	Simulation (std::filesystem::path &settingPath, std::filesystem::path &outputDirectory)
void	run ()

Public Attributes
MPS	mps
Loader	loader
Saver	saver
std::chrono::system_clock::time_point	realStartTime
std::chrono::system_clock::time_point	realEndTime
double	startTime
double	time
double	endTime
double	dt
double	outputPeriod
int	timeStep = 0

Private Member Functions
void	startSimulation ()
template<typename Rep , typename Period >
std::string	calHourMinuteSecond (std::chrono::duration< Rep, Period > d)
void	endSimulation ()
void	timeStepReport (const std::chrono::system_clock::time_point &timeStepStartTime, const std::chrono::system_clock::time_point &timeStepEndTime)
	Report time step information to the console.
bool	saveCondition ()
std::string	getCurrentTimeString ()

Detailed Description

Simulation class

This class is responsible for the simulation process. It loads the input, saves the results, and manages the time. It also contains the main loop of the simulation.

Definition at line 22 of file simulation.hpp.

Constructor & Destructor Documentation

Simulation()

Simulation::Simulation	(	std::filesystem::path &	settingPath,
		std::filesystem::path &	outputDirectory )

Definition at line 17 of file simulation.cpp.

                                                                   {
    Input input = loader.load(settingPath, outputDirectory);
    saver       = Saver(outputDirectory, input.settings.outputVtkInBinary);
 
    mps          = MPSFactory::create(input);
    startTime    = input.startTime;
    time         = startTime;
    endTime      = input.settings.endTime;
    dt           = input.settings.dt;
    outputPeriod = input.settings.outputPeriod;
}

Here is the call graph for this function:

Member Function Documentation

run()

void Simulation::run

(

)

Definition at line 29 of file simulation.cpp.

                     {
    startSimulation();
    saver.save(mps, time);
 
    while (time < endTime) {
        auto timeStepStartTime = chrono::system_clock::now();
 
        mps.stepForward();
        timeStep++;
        time += dt;
 
        auto timeStepEndTime = chrono::system_clock::now();
 
        timeStepReport(timeStepStartTime, timeStepEndTime);
        if (saveCondition()) {
            saver.save(mps, time);
        }
    }
    endSimulation();
}

Here is the call graph for this function:

Here is the caller graph for this function:

startSimulation()

void Simulation::startSimulation ( )

private

Definition at line 50 of file simulation.cpp.

                                 {
    cout << endl;
    cout << "*** START SIMULATION ***" << endl;
    realStartTime = chrono::system_clock::now();
}

Here is the caller graph for this function:

calHourMinuteSecond()

template<typename Rep , typename Period >

std::string Simulation::calHourMinuteSecond ( std::chrono::duration< Rep, Period > d )

inlineprivate

Definition at line 42 of file simulation.hpp.

                                                                                                             {
        auto h = std::chrono::duration_cast<std::chrono::hours>(d);
        d -= h;
        auto m = std::chrono::duration_cast<std::chrono::minutes>(d);
        d -= m;
        auto s = std::chrono::duration_cast<std::chrono::seconds>(d);
 
        std::stringstream out;
        out << h.count() << "h ";
        out << std::setfill('0') << std::setw(2) << m.count() << "m " << s.count() << "s";
        return out.str();
    }

Here is the caller graph for this function:

endSimulation()

void Simulation::endSimulation ( )

private

Definition at line 56 of file simulation.cpp.

                               {
    realEndTime = chrono::system_clock::now();
    cout << endl;
    cout << "Total Simulation time = " << calHourMinuteSecond(realEndTime - realStartTime) << endl;
 
    cout << endl;
    cout << "*** END SIMULATION ***" << endl;
}

Here is the call graph for this function:

Here is the caller graph for this function:

timeStepReport()

void Simulation::timeStepReport ( const std::chrono::system_clock::time_point & timeStepStartTime, const std::chrono::system_clock::time_point & timeStepEndTime )

private

Report time step information to the console.

Definition at line 65 of file simulation.cpp.

  {
    auto elapsedTime = timeStepEndTime - realStartTime;
    auto elapsed     = "elapsed=" + calHourMinuteSecond(elapsedTime);
 
    double ave = 0.0;
    if (timeStep != 0) {
        ave = (double) (chrono::duration_cast<chrono::nanoseconds>(elapsedTime).count()) / (timeStep * 1e9);
    }
 
    std::string remain = "remain=";
    if (timeStep == 0) {
        remain += "-h --m --s";
    } else {
        auto totalTime = chrono::nanoseconds((int64_t) (ave * (endTime - startTime) / dt * 1e9));
        remain += calHourMinuteSecond(totalTime - elapsedTime);
    }
    double last = chrono::duration_cast<chrono::nanoseconds>(timeStepEndTime - timeStepStartTime).count() * 1e-9;
 
    // terminal output
    printf(
        "%d: dt=%.gs   t=%.3lfs   fin=%.1lfs   %s   %s   ave=%.3lfs/step   "
        "last=%.3lfs/step   out=%dfiles   Courant=%.2lf\n",
        timeStep,
        dt,
        time,
        endTime,
        elapsed.c_str(),
        remain.c_str(),
        ave,
        last,
        saver.getFileNumber(),
        mps.courant
    );
 
    // error output
    fprintf(stderr, "%4d: t=%.3lfs\n", timeStep, time);
}

Here is the call graph for this function:

Here is the caller graph for this function:

saveCondition()

bool Simulation::saveCondition ( )

private

Definition at line 105 of file simulation.cpp.

                               {
    // NOTE: Is fileNumber really necessary?
    return time - startTime >= outputPeriod * double(saver.getFileNumber());
}

Here is the call graph for this function:

Here is the caller graph for this function:

getCurrentTimeString()

std::string Simulation::getCurrentTimeString ( )

private

Definition at line 111 of file simulation.cpp.

                                           {
    auto currentTime  = chrono::system_clock::to_time_t(chrono::system_clock::now());
    std::tm* timeInfo = std::localtime(&currentTime);
    std::stringstream formattedTime;
    formattedTime << std::put_time(timeInfo, "%Y-%m-%d_%H-%M-%S");
    std::string formattedTimeString = formattedTime.str();
 
    return formattedTimeString;
}

Member Data Documentation

mps

MPS Simulation::mps

Definition at line 26 of file simulation.hpp.

loader

Loader Simulation::loader

Definition at line 27 of file simulation.hpp.

saver

Saver Simulation::saver

Definition at line 28 of file simulation.hpp.

realStartTime

std::chrono::system_clock::time_point Simulation::realStartTime

Definition at line 30 of file simulation.hpp.

realEndTime

std::chrono::system_clock::time_point Simulation::realEndTime

Definition at line 30 of file simulation.hpp.

startTime

double Simulation::startTime

Definition at line 31 of file simulation.hpp.

time

double Simulation::time

Definition at line 31 of file simulation.hpp.

endTime

double Simulation::endTime

Definition at line 31 of file simulation.hpp.

dt

double Simulation::dt

Definition at line 31 of file simulation.hpp.

outputPeriod

double Simulation::outputPeriod

Definition at line 32 of file simulation.hpp.

timeStep

int Simulation::timeStep = 0

Definition at line 33 of file simulation.hpp.

---

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

• src/simulation.hpp
• src/simulation.cpp