OGS
ProcessLib::TimeLoop Class Reference

Detailed Description

Time loop capable of time-integrating several processes at once.

Definition at line 32 of file TimeLoop.h.

#include <TimeLoop.h>

Collaboration diagram for ProcessLib::TimeLoop:
[legend]

Public Member Functions

 TimeLoop (std::vector< Output > &&outputs, std::vector< std::unique_ptr< ProcessData > > &&per_process_data, std::unique_ptr< NumLib::StaggeredCoupling > &&staggered_coupling, const NumLib::Time &start_time, const NumLib::Time &end_time)
void initialize ()
 initialize output, convergence criterion, etc.
void outputLastTimeStep () const
 ~TimeLoop ()
bool executeTimeStep ()
bool calculateNextTimeStep ()
NumLib::Time endTime () const
NumLib::Time currentTime () const

Public Attributes

bool successful_time_step = true

Private Types

using TimeStepConstraintCallback

Private Member Functions

bool preTsNonlinearSolvePostTs (NumLib::Time const &t, double const dt, std::size_t const timesteps)
NumLib::NonlinearSolverStatus solveUncoupledEquationSystems (const NumLib::Time &t, const double dt, const std::size_t timestep_id)
 Member to solver non coupled systems of equations, which can be a single system of equations, or several systems of equations without any dependency among the different systems.
NumLib::NonlinearSolverStatus solveCoupledEquationSystemsByStaggeredScheme (const NumLib::Time &t, const double dt, const std::size_t timestep_id)
 Member to solver coupled systems of equations by the staggered scheme.
std::pair< NumLib::TimeIncrement, bool > computeTimeStepping (const double prev_dt, NumLib::Time &t, std::size_t &accepted_steps, std::size_t &rejected_steps, std::vector< TimeStepConstraintCallback > const &time_step_constraints)
template<typename OutputClassMember>
void outputSolutions (unsigned timestep, const double t, OutputClassMember output_class_member) const
std::vector< TimeStepConstraintCallbackgenerateOutputTimeStepConstraints (std::vector< double > &&fixed_times) const
void preOutputInitialConditions (NumLib::Time const &t, const double dt) const

Private Attributes

std::vector< GlobalVector * > _process_solutions
std::vector< GlobalVector * > _process_solutions_prev
std::vector< Output_outputs
std::vector< std::unique_ptr< ProcessData > > _per_process_data
const NumLib::Time _start_time
const NumLib::Time _end_time
NumLib::Time _current_time = _start_time
std::size_t _accepted_steps = 0
std::size_t _rejected_steps = 0
NumLib::TimeIncrement _dt {0.}
int _repeating_times_of_rejected_step = 0
bool _last_step_rejected = false
std::unique_ptr< NumLib::StaggeredCoupling_staggered_coupling

Member Typedef Documentation

◆ TimeStepConstraintCallback

Initial value:
std::function<double(NumLib::Time const&, double)>

Definition at line 91 of file TimeLoop.h.

Constructor & Destructor Documentation

◆ TimeLoop()

ProcessLib::TimeLoop::TimeLoop ( std::vector< Output > && outputs,
std::vector< std::unique_ptr< ProcessData > > && per_process_data,
std::unique_ptr< NumLib::StaggeredCoupling > && staggered_coupling,
const NumLib::Time & start_time,
const NumLib::Time & end_time )

Definition at line 264 of file TimeLoop.cpp.

269 : _outputs{std::move(outputs)},
270 _per_process_data(std::move(per_process_data)),
271 _start_time(start_time),
272 _end_time(end_time),
273 _staggered_coupling(std::move(staggered_coupling))
274{
275}
std::vector< std::unique_ptr< ProcessData > > _per_process_data
Definition TimeLoop.h:126
std::vector< Output > _outputs
Definition TimeLoop.h:125
std::unique_ptr< NumLib::StaggeredCoupling > _staggered_coupling
Definition TimeLoop.h:137
const NumLib::Time _end_time
Definition TimeLoop.h:129
const NumLib::Time _start_time
Definition TimeLoop.h:128

References _end_time, _outputs, _per_process_data, _staggered_coupling, and _start_time.

◆ ~TimeLoop()

ProcessLib::TimeLoop::~TimeLoop ( )

Definition at line 734 of file TimeLoop.cpp.

735{
736 for (auto* x : _process_solutions)
737 {
739 }
740 for (auto* x : _process_solutions_prev)
741 {
743 }
744}
virtual void releaseVector(GlobalVector const &x)=0
std::vector< GlobalVector * > _process_solutions
Definition TimeLoop.h:123
std::vector< GlobalVector * > _process_solutions_prev
Definition TimeLoop.h:124
static NUMLIB_EXPORT VectorProvider & provider

References _process_solutions, _process_solutions_prev, and NumLib::GlobalVectorProvider::provider.

Member Function Documentation

◆ calculateNextTimeStep()

bool ProcessLib::TimeLoop::calculateNextTimeStep ( )

Computes and sets the next timestep.

Attention
The timestepper might reject the current timestep and repeat it (with a reduced timestep size).
Returns
true if the simulation (time) has not finished, yet, false otherwise.

Definition at line 524 of file TimeLoop.cpp.

525{
526 const double prev_dt = _dt();
527 // keep a copy of _current_time to check if a new point in time is computed
528 auto const current_time = _current_time;
529
530 const std::size_t timesteps = _accepted_steps + 1;
531
532 auto const time_step_constraints = generateOutputTimeStepConstraints(
534
535 // _last_step_rejected is also checked in computeTimeStepping.
536 std::tie(_dt, _last_step_rejected) =
538 _rejected_steps, time_step_constraints);
539
541 {
542 outputSolutions(timesteps, current_time(), &Output::doOutput);
543 }
544
545 // check if the newly computed time point (=_current_time + _dt()) differs
546 // from the previously computed time point (current_time) saved at the
547 // beginning of the method
548 if (current_time == (_current_time + _dt()))
549 {
550 DBUG("current time == previous time + dt : {:a} == {:a} + {:a} = {:a}",
551 current_time(), _current_time(), _dt(), _current_time() + _dt());
552 ERR("The time increment {} results in exactly the same time {} as the "
553 "last rejected time step.\n"
554 "Time stepping stops at time step {:d} and time {}.",
555 _dt, current_time, timesteps, _current_time);
556 return false;
557 }
558
560 {
561 return false;
562 }
563
564 return true;
565}
void DBUG(fmt::format_string< Args... > fmt, Args &&... args)
Definition Logging.h:22
void ERR(fmt::format_string< Args... > fmt, Args &&... args)
Definition Logging.h:40
void doOutput(Process const &process, const int process_id, int const timestep, const NumLib::Time &t, int const iteration, bool const converged, std::vector< GlobalVector * > const &xs) const
NumLib::TimeIncrement _dt
Definition TimeLoop.h:133
NumLib::Time _current_time
Definition TimeLoop.h:130
std::pair< NumLib::TimeIncrement, bool > computeTimeStepping(const double prev_dt, NumLib::Time &t, std::size_t &accepted_steps, std::size_t &rejected_steps, std::vector< TimeStepConstraintCallback > const &time_step_constraints)
Definition TimeLoop.cpp:290
void outputSolutions(unsigned timestep, const double t, OutputClassMember output_class_member) const
Definition TimeLoop.cpp:708
std::size_t _accepted_steps
Definition TimeLoop.h:131
std::size_t _rejected_steps
Definition TimeLoop.h:132
std::vector< TimeStepConstraintCallback > generateOutputTimeStepConstraints(std::vector< double > &&fixed_times) const
Definition TimeLoop.cpp:436
std::vector< double > calculateUniqueFixedTimesForAllOutputs(std::vector< Output > const &outputs)

References _accepted_steps, _current_time, _dt, _end_time, _last_step_rejected, _outputs, _rejected_steps, ProcessLib::calculateUniqueFixedTimesForAllOutputs(), computeTimeStepping(), DBUG(), ProcessLib::Output::doOutput(), ERR(), generateOutputTimeStepConstraints(), and outputSolutions().

◆ computeTimeStepping()

std::pair< NumLib::TimeIncrement, bool > ProcessLib::TimeLoop::computeTimeStepping ( const double prev_dt,
NumLib::Time & t,
std::size_t & accepted_steps,
std::size_t & rejected_steps,
std::vector< TimeStepConstraintCallback > const & time_step_constraints )
private

Find the minimum time step size among the predicted step sizes of processes and step it as common time step size.

Parameters
prev_dtPrevious time step size.
tCurrent time.
accepted_stepsAccepted time steps that are counted in this function.
rejected_stepsRejected time steps that are counted in this function.
time_step_constraintsFunctions that are evaluate to influence the time step size (for instance a fixed output time)
Returns
the time step size and the information if the last time step was rejected

Definition at line 290 of file TimeLoop.cpp.

294{
295 bool all_process_steps_accepted = true;
296 // Get minimum time step size among step sizes of all processes.
297 NumLib::TimeIncrement dt{std::numeric_limits<double>::max()};
298 constexpr double eps = std::numeric_limits<double>::epsilon();
299
300 bool const is_initial_step =
301 std::any_of(_per_process_data.begin(), _per_process_data.end(),
302 [](auto const& ppd) -> bool
303 { return ppd->timestep_current.timeStepNumber() == 0; });
304
305 for (std::size_t i = 0; i < _per_process_data.size(); i++)
306 {
307 auto& ppd = *_per_process_data[i];
308 auto& timestep_algorithm = *ppd.timestep_algorithm.get();
309
310 auto const& x = *_process_solutions[i];
311 auto const& x_prev = *_process_solutions_prev[i];
312
313 const double solution_error =
314 computationOfChangeNeeded(timestep_algorithm, t)
316 x, x_prev,
317 ppd.conv_crit.get() ? ppd.conv_crit->getVectorNormType()
319 : 0.0;
320
321 ppd.timestep_current.setAccepted(
322 ppd.nonlinear_solver_status.error_norms_met);
323
324 auto const timestepper_dt = timestep_algorithm.next(
325 solution_error, ppd.nonlinear_solver_status.number_iterations,
326 ppd.timestep_previous, ppd.timestep_current);
327
328 if (!ppd.timestep_current.isAccepted())
329 {
330 // Not all processes have accepted steps.
331 all_process_steps_accepted = false;
332 }
333
334 if (!ppd.nonlinear_solver_status.error_norms_met)
335 {
336 WARN(
337 "Time step will be rejected due to nonlinear solver "
338 "divergence.");
339 all_process_steps_accepted = false;
340 }
341
342 if (timestepper_dt > eps || t < timestep_algorithm.end())
343 {
344 dt = NumLib::TimeIncrement{std::min(timestepper_dt, dt())};
345 }
346 }
347
348 if (all_process_steps_accepted)
349 {
351 }
352 else
353 {
355 }
356
357 bool last_step_rejected = false;
358 if (!is_initial_step)
359 {
360 if (all_process_steps_accepted)
361 {
362 accepted_steps++;
363 last_step_rejected = false;
364 }
365 else
366 {
367 if (t <= _end_time)
368 {
369 t -= prev_dt;
370 rejected_steps++;
371 last_step_rejected = true;
372 }
373 }
374 }
375
376 // adjust step size considering external communciation_point_calculators
377 for (auto const& time_step_constraint : time_step_constraints)
378 {
379 dt = NumLib::TimeIncrement{
380 std::min(dt(), time_step_constraint(t, dt()))};
381 }
382
383 // Check whether the time stepping is stabilized
384 if (std::abs(dt() - prev_dt) < eps)
385 {
386 if (last_step_rejected)
387 {
388 OGS_FATAL(
389 "The new step size of {} is the same as that of the previous "
390 "rejected time step. \nPlease re-run ogs with a proper "
391 "adjustment in the numerical settings, \ne.g. those for time "
392 "stepper, local or global non-linear solver.",
393 dt);
394 }
395 else
396 {
397 DBUG("The time stepping is stabilized with the step size of {}.",
398 dt);
399 }
400 }
401
402 // Reset the time step with the minimum step size, dt
403 // Update the solution of the previous time step.
404 for (std::size_t i = 0; i < _per_process_data.size(); i++)
405 {
406 if (all_process_steps_accepted)
407 {
408 auto& ppd = *_per_process_data[i];
409 NumLib::updateTimeSteps(dt(), ppd.timestep_previous,
410 ppd.timestep_current);
411 }
412
413 auto& x = *_process_solutions[i];
414 auto& x_prev = *_process_solutions_prev[i];
415 if (all_process_steps_accepted)
416 {
417 MathLib::LinAlg::copy(x, x_prev); // pushState
418 }
419 else
420 {
421 if (t <= _end_time)
422 {
423 WARN(
424 "Time step {:d} was rejected {:d} times and it will be "
425 "repeated with a reduced step size.",
426 accepted_steps + 1, _repeating_times_of_rejected_step);
427 MathLib::LinAlg::copy(x_prev, x); // popState
428 }
429 }
430 }
431
432 return {dt, last_step_rejected};
433}
#define OGS_FATAL(...)
Definition Error.h:19
void WARN(fmt::format_string< Args... > fmt, Args &&... args)
Definition Logging.h:34
int _repeating_times_of_rejected_step
Definition TimeLoop.h:134
void copy(PETScVector const &x, PETScVector &y)
Definition LinAlg.cpp:30
double computeRelativeNorm(VectorType const &x, VectorType const &y, MathLib::VecNormType norm_type)
Definition LinAlg.h:292
void updateTimeSteps(double const dt, TimeStep &previous_timestep, TimeStep &current_timestep)
Definition TimeStep.h:101
bool computationOfChangeNeeded(NumLib::TimeStepAlgorithm const &timestep_algorithm, NumLib::Time const &time)
Definition TimeLoop.cpp:277

References _end_time, _per_process_data, _process_solutions, _process_solutions_prev, _repeating_times_of_rejected_step, ProcessLib::computationOfChangeNeeded(), MathLib::LinAlg::computeRelativeNorm(), MathLib::LinAlg::copy(), DBUG(), MathLib::NORM2, OGS_FATAL, NumLib::updateTimeSteps(), and WARN().

Referenced by calculateNextTimeStep(), and initialize().

◆ currentTime()

NumLib::Time ProcessLib::TimeLoop::currentTime ( ) const
inline

Definition at line 57 of file TimeLoop.h.

57{ return _current_time; }

References _current_time.

◆ endTime()

NumLib::Time ProcessLib::TimeLoop::endTime ( ) const
inline

Definition at line 56 of file TimeLoop.h.

56{ return _end_time; }

References _end_time.

◆ executeTimeStep()

bool ProcessLib::TimeLoop::executeTimeStep ( )

Definition at line 503 of file TimeLoop.cpp.

504{
505 BaseLib::RunTime time_timestep;
506 time_timestep.start();
507
508 _current_time += _dt();
509
510 const std::size_t timesteps = _accepted_steps + 1;
511 // TODO(wenqing): , input option for time unit.
512 INFO("Time step #{:d} started. Time: {}. Step size: {}.", timesteps,
514
516
519 INFO("[time] Time step #{:d} took {:g} s.", timesteps,
520 time_timestep.elapsed());
522}
void INFO(fmt::format_string< Args... > fmt, Args &&... args)
Definition Logging.h:28
double elapsed() const
Get the elapsed time in seconds.
Definition RunTime.h:31
void start()
Start the timer.
Definition RunTime.h:21
bool preTsNonlinearSolvePostTs(NumLib::Time const &t, double const dt, std::size_t const timesteps)
Definition TimeLoop.cpp:582
void updateDeactivatedSubdomains(std::vector< std::unique_ptr< ProcessLib::ProcessData > > const &per_process_data, double const t)
Definition TimeLoop.cpp:21

References _accepted_steps, _current_time, _dt, _per_process_data, BaseLib::RunTime::elapsed(), INFO(), preTsNonlinearSolvePostTs(), BaseLib::RunTime::start(), and successful_time_step.

◆ generateOutputTimeStepConstraints()

std::vector< TimeLoop::TimeStepConstraintCallback > ProcessLib::TimeLoop::generateOutputTimeStepConstraints ( std::vector< double > && fixed_times) const
private

Definition at line 436 of file TimeLoop.cpp.

438{
439 std::vector<TimeStepConstraintCallback> const time_step_constraints{
440 [fixed_times = std::move(fixed_times)](NumLib::Time const& t, double dt)
441 { return NumLib::possiblyClampDtToNextFixedTime(t, dt, fixed_times); },
442 [this](NumLib::Time const& t, double dt) -> double
443 {
444 if (t < _end_time && _end_time < t + dt)
445 {
446 return _end_time() - t();
447 }
448 return dt;
449 }};
450 return time_step_constraints;
451}
double possiblyClampDtToNextFixedTime(Time const &t, double const dt, std::vector< double > const &fixed_output_times)

References _end_time, and NumLib::possiblyClampDtToNextFixedTime().

Referenced by calculateNextTimeStep(), and initialize().

◆ initialize()

void ProcessLib::TimeLoop::initialize ( )

initialize output, convergence criterion, etc.

Definition at line 454 of file TimeLoop.cpp.

455{
456 for (auto const& process_data : _per_process_data)
457 {
458 auto& pcs = process_data->process;
459 for (auto& output : _outputs)
460 {
461 output.addProcess(pcs);
462 }
463
464 setTimeDiscretizedODESystem(*process_data);
465
466 if (auto* conv_crit =
467 dynamic_cast<NumLib::ConvergenceCriterionPerComponent*>(
468 process_data->conv_crit.get()))
469 {
470 int const process_id = process_data->process_id;
471 conv_crit->setDOFTable(pcs.getDOFTable(process_id), pcs.getMesh());
472 }
473 }
474
475 // initial solution storage
478
480 {
481 _staggered_coupling->initializeCoupledSolutions(_process_solutions);
482 }
483
485
486 auto const time_step_constraints = generateOutputTimeStepConstraints(
488
489 std::tie(_dt, _last_step_rejected) =
491 _rejected_steps, time_step_constraints);
492
493 // Output initial conditions
494 {
497 }
498
501}
void preOutputInitialConditions(NumLib::Time const &t, const double dt) const
Definition TimeLoop.cpp:746
void setTimeDiscretizedODESystem(ProcessData &process_data, NumLib::ODESystem< ODETag, NumLib::NonlinearSolverTag::Picard > &ode_sys)
Definition TimeLoop.cpp:107
void calculateNonEquilibriumInitialResiduum(std::vector< std::unique_ptr< ProcessData > > const &per_process_data, std::vector< GlobalVector * > const &process_solutions, std::vector< GlobalVector * > const &process_solutions_prev)
Definition TimeLoop.cpp:201
std::pair< std::vector< GlobalVector * >, std::vector< GlobalVector * > > setInitialConditions(NumLib::Time const &t0, std::vector< std::unique_ptr< ProcessData > > const &per_process_data)
Definition TimeLoop.cpp:166

References _accepted_steps, _current_time, _dt, _last_step_rejected, _outputs, _per_process_data, _process_solutions, _process_solutions_prev, _rejected_steps, _staggered_coupling, _start_time, ProcessLib::calculateNonEquilibriumInitialResiduum(), ProcessLib::calculateUniqueFixedTimesForAllOutputs(), computeTimeStepping(), ProcessLib::Output::doOutput(), generateOutputTimeStepConstraints(), outputSolutions(), preOutputInitialConditions(), ProcessLib::setInitialConditions(), and ProcessLib::setTimeDiscretizedODESystem().

◆ outputLastTimeStep()

void ProcessLib::TimeLoop::outputLastTimeStep ( ) const

Definition at line 567 of file TimeLoop.cpp.

568{
569 INFO(
570 "The whole computation of the time stepping took {:d} steps, in which\n"
571 "\t the accepted steps are {:d}, and the rejected steps are {:d}.\n",
573
574 // output last time step
576 {
579 }
580}
void doOutputLastTimestep(Process const &process, const int process_id, int const timestep, const NumLib::Time &t, int const iteration, bool const converged, std::vector< GlobalVector * > const &xs) const

References _accepted_steps, _current_time, _rejected_steps, ProcessLib::Output::doOutputLastTimestep(), INFO(), outputSolutions(), and successful_time_step.

◆ outputSolutions()

template<typename OutputClassMember>
void ProcessLib::TimeLoop::outputSolutions ( unsigned timestep,
const double t,
OutputClassMember output_class_member ) const
private

Definition at line 708 of file TimeLoop.cpp.

710{
711 for (auto const& process_data : _per_process_data)
712 {
713 // If nonlinear solver diverged, the solution has already been
714 // saved.
715 if (!process_data->nonlinear_solver_status.error_norms_met)
716 {
717 continue;
718 }
719
720 auto const process_id = process_data->process_id;
721 auto const& pcs = process_data->process;
722
723 for (auto const& output_object : _outputs)
724 {
725 (output_object.*output_class_member)(
726 pcs, process_id, timestep, NumLib::Time(t),
727 process_data->nonlinear_solver_status.number_iterations,
728 process_data->nonlinear_solver_status.error_norms_met,
730 }
731 }
732}

References _outputs, _per_process_data, and _process_solutions.

Referenced by calculateNextTimeStep(), initialize(), and outputLastTimeStep().

◆ preOutputInitialConditions()

void ProcessLib::TimeLoop::preOutputInitialConditions ( NumLib::Time const & t,
const double dt ) const
private

Definition at line 746 of file TimeLoop.cpp.

748{
749 for (auto const& process_data : _per_process_data)
750 {
751 // If nonlinear solver diverged, the solution has already been
752 // saved.
753 if (!process_data->nonlinear_solver_status.error_norms_met)
754 {
755 continue;
756 }
757
758 auto const process_id = process_data->process_id;
759 auto& pcs = process_data->process;
760
761 process_data->time_disc->nextTimestep(t(), dt);
762
763 pcs.preTimestep(_process_solutions, _start_time(), dt, process_id);
764
765 pcs.preOutput(_start_time(), dt, _process_solutions,
766 _process_solutions_prev, process_id);
767
768 // Update secondary variables, which might be uninitialized, before
769 // output.
770 pcs.computeSecondaryVariable(_start_time(), dt, _process_solutions,
771 *_process_solutions_prev[process_id],
772 process_id);
773 }
774}

References _per_process_data, _process_solutions, _process_solutions_prev, and _start_time.

Referenced by initialize().

◆ preTsNonlinearSolvePostTs()

bool ProcessLib::TimeLoop::preTsNonlinearSolvePostTs ( NumLib::Time const & t,
double const dt,
std::size_t const timesteps )
private

Definition at line 582 of file TimeLoop.cpp.

584{
586
587 NumLib::NonlinearSolverStatus nonlinear_solver_status;
588
590 {
591 nonlinear_solver_status =
593 }
594 else
595 {
596 nonlinear_solver_status =
597 solveUncoupledEquationSystems(t, dt, timesteps);
598 }
599
600 // Run post time step only if the last iteration was successful.
601 // Otherwise it runs the risks to get the same errors as in the last
602 // iteration, an exception thrown in assembly, for example.
603 if (nonlinear_solver_status.error_norms_met)
604 {
605 // Later on, the timestep_algorithm might reject the timestep. We assume
606 // that this is a rare case, so still, we call preOutput() here. We
607 // don't expect a large overhead from it.
610 _outputs);
611
615 }
616 return nonlinear_solver_status.error_norms_met;
617}
NumLib::NonlinearSolverStatus solveUncoupledEquationSystems(const NumLib::Time &t, const double dt, const std::size_t timestep_id)
Member to solver non coupled systems of equations, which can be a single system of equations,...
Definition TimeLoop.cpp:642
NumLib::NonlinearSolverStatus solveCoupledEquationSystemsByStaggeredScheme(const NumLib::Time &t, const double dt, const std::size_t timestep_id)
Member to solver coupled systems of equations by the staggered scheme.
Definition TimeLoop.cpp:685
void preTimestepForAllProcesses(NumLib::Time const &t, double const dt, std::vector< std::unique_ptr< ProcessData > > const &per_process_data, std::vector< GlobalVector * > const &_process_solutions)
Definition TimeLoop.cpp:74
void postTimestepForAllProcesses(NumLib::Time const &t, double const dt, std::vector< std::unique_ptr< ProcessData > > const &per_process_data, std::vector< GlobalVector * > const &process_solutions, std::vector< GlobalVector * > const &process_solutions_prev)
Definition TimeLoop.cpp:87
void preOutputForAllProcesses(int const timestep, NumLib::Time const &t, double const dt, const NumLib::Time &end_time, std::vector< std::unique_ptr< ProcessLib::ProcessData > > const &per_process_data, std::vector< GlobalVector * > const &process_solutions, std::vector< GlobalVector * > const &process_solutions_prev, std::vector< ProcessLib::Output > const &outputs)
Definition TimeLoop.cpp:47

References _end_time, _outputs, _per_process_data, _process_solutions, _process_solutions_prev, _staggered_coupling, NumLib::NonlinearSolverStatus::error_norms_met, ProcessLib::postTimestepForAllProcesses(), ProcessLib::preTimestepForAllProcesses(), solveCoupledEquationSystemsByStaggeredScheme(), and solveUncoupledEquationSystems().

Referenced by executeTimeStep().

◆ solveCoupledEquationSystemsByStaggeredScheme()

NumLib::NonlinearSolverStatus ProcessLib::TimeLoop::solveCoupledEquationSystemsByStaggeredScheme ( const NumLib::Time & t,
const double dt,
const std::size_t timestep_id )
private

Member to solver coupled systems of equations by the staggered scheme.

Parameters
tCurrent time
dtTime step size
timestep_idIndex of the time step
Returns
true: if all nonlinear solvers convergence. false: if any of nonlinear solvers divergences.

Definition at line 685 of file TimeLoop.cpp.

687{
688 auto const nonlinear_solver_status =
689 _staggered_coupling->execute<ProcessData, Output>(
690 t(), dt, timestep_id, _process_solutions, _process_solutions_prev,
692
693 _last_step_rejected = nonlinear_solver_status.error_norms_met;
694
695 for (auto const& process_data : _per_process_data)
696 {
697 auto& pcs = process_data->process;
698 int const process_id = process_data->process_id;
699 auto& ode_sys = *process_data->tdisc_ode_sys;
700 pcs.solveReactionEquation(_process_solutions, _process_solutions_prev,
701 t(), dt, ode_sys, process_id);
702 }
703
704 return nonlinear_solver_status;
705}
NumLib::NonlinearSolverStatus solveOneTimeStepOneProcess(std::vector< GlobalVector * > &x, std::vector< GlobalVector * > const &x_prev, std::size_t const timestep, double const t, double const delta_t, ProcessData const &process_data, std::vector< Output > const &outputs)
Definition TimeLoop.cpp:217

References _last_step_rejected, _outputs, _per_process_data, _process_solutions, _process_solutions_prev, _staggered_coupling, and ProcessLib::solveOneTimeStepOneProcess().

Referenced by preTsNonlinearSolvePostTs().

◆ solveUncoupledEquationSystems()

NumLib::NonlinearSolverStatus ProcessLib::TimeLoop::solveUncoupledEquationSystems ( const NumLib::Time & t,
const double dt,
const std::size_t timestep_id )
private

Member to solver non coupled systems of equations, which can be a single system of equations, or several systems of equations without any dependency among the different systems.

Parameters
tCurrent time
dtTime step size
timestep_idIndex of the time step
Returns
true: if all nonlinear solvers convergence. false: if any of nonlinear solvers divergences.

Definition at line 642 of file TimeLoop.cpp.

644{
645 NumLib::NonlinearSolverStatus nonlinear_solver_status;
646
647 for (auto const& process_data : _per_process_data)
648 {
649 auto const process_id = process_data->process_id;
650 nonlinear_solver_status = solveMonolithicProcess(
651 t, dt, timestep_id, *process_data, _process_solutions,
653
654 process_data->nonlinear_solver_status = nonlinear_solver_status;
655 if (!nonlinear_solver_status.error_norms_met)
656 {
657 ERR("The nonlinear solver failed in time step #{:d} at t = {} s "
658 "for process #{:d}.",
659 timestep_id, t, process_id);
660
661 if (!process_data->timestep_algorithm->canReduceTimestepSize(
662 process_data->timestep_current,
663 process_data->timestep_previous))
664 {
665 // save unsuccessful solution
666 for (auto const& output : _outputs)
667 {
668 output.doOutputAlways(
669 process_data->process, process_id, timestep_id, t,
670 process_data->nonlinear_solver_status.number_iterations,
671 process_data->nonlinear_solver_status.error_norms_met,
673 }
675 }
676
677 return nonlinear_solver_status;
678 }
679 }
680
681 return nonlinear_solver_status;
682}
static constexpr std::string_view timestepper_cannot_reduce_dt
Definition TimeLoop.cpp:639
static NumLib::NonlinearSolverStatus solveMonolithicProcess(const NumLib::Time &t, const double dt, const std::size_t timestep_id, ProcessData const &process_data, std::vector< GlobalVector * > &x, std::vector< GlobalVector * > const &x_prev, std::vector< Output > const &outputs)
Definition TimeLoop.cpp:619

References _outputs, _per_process_data, _process_solutions, _process_solutions_prev, ERR(), NumLib::NonlinearSolverStatus::error_norms_met, OGS_FATAL, ProcessLib::solveMonolithicProcess(), and ProcessLib::timestepper_cannot_reduce_dt.

Referenced by preTsNonlinearSolvePostTs().

Member Data Documentation

◆ _accepted_steps

std::size_t ProcessLib::TimeLoop::_accepted_steps = 0
private

Definition at line 131 of file TimeLoop.h.

Referenced by calculateNextTimeStep(), executeTimeStep(), initialize(), and outputLastTimeStep().

◆ _current_time

NumLib::Time ProcessLib::TimeLoop::_current_time = _start_time
private

◆ _dt

NumLib::TimeIncrement ProcessLib::TimeLoop::_dt {0.}
private

Definition at line 133 of file TimeLoop.h.

133{0.};

Referenced by calculateNextTimeStep(), executeTimeStep(), and initialize().

◆ _end_time

const NumLib::Time ProcessLib::TimeLoop::_end_time
private

◆ _last_step_rejected

bool ProcessLib::TimeLoop::_last_step_rejected = false
private

◆ _outputs

◆ _per_process_data

◆ _process_solutions

◆ _process_solutions_prev

◆ _rejected_steps

std::size_t ProcessLib::TimeLoop::_rejected_steps = 0
private

Definition at line 132 of file TimeLoop.h.

Referenced by calculateNextTimeStep(), initialize(), and outputLastTimeStep().

◆ _repeating_times_of_rejected_step

int ProcessLib::TimeLoop::_repeating_times_of_rejected_step = 0
private

Definition at line 134 of file TimeLoop.h.

Referenced by computeTimeStepping().

◆ _staggered_coupling

std::unique_ptr<NumLib::StaggeredCoupling> ProcessLib::TimeLoop::_staggered_coupling
private

◆ _start_time

const NumLib::Time ProcessLib::TimeLoop::_start_time
private

Definition at line 128 of file TimeLoop.h.

Referenced by TimeLoop(), initialize(), and preOutputInitialConditions().

◆ successful_time_step

bool ProcessLib::TimeLoop::successful_time_step = true

Definition at line 58 of file TimeLoop.h.

Referenced by executeTimeStep(), and outputLastTimeStep().


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