Revision 2189c193605fd58d277e5d07efb04c0e1c0882b5 authored by Lars Bilke on 11 April 2023, 11:46:45 UTC, committed by Lars Bilke on 11 April 2023, 11:46:45 UTC
Added generic numerical differentiation algorithm See merge request ogs/ogs!4522
TimeLoop.h
/**
* \file
*
* \copyright
* Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
* Distributed under a Modified BSD License.
* See accompanying file LICENSE.txt or
* http://www.opengeosys.org/project/license
*/
#pragma once
#include <functional>
#include <memory>
#include "NumLib/ODESolver/NonlinearSolver.h"
#include "NumLib/TimeStepping/Algorithms/TimeStepAlgorithm.h"
#include "Process.h"
#include "ProcessLib/Output/Output.h"
namespace NumLib
{
class ConvergenceCriterion;
}
namespace ChemistryLib
{
class ChemicalSolverInterface;
}
namespace ProcessLib
{
struct ProcessData;
/// Time loop capable of time-integrating several processes at once.
class TimeLoop
{
public:
TimeLoop(std::vector<Output>&& outputs,
std::vector<std::unique_ptr<ProcessData>>&& per_process_data,
const int global_coupling_max_iterations,
std::vector<std::unique_ptr<NumLib::ConvergenceCriterion>>&&
global_coupling_conv_crit,
const double start_time, const double end_time);
void initialize();
void outputLastTimeStep() const;
~TimeLoop();
bool executeTimeStep();
bool calculateNextTimeStep();
double endTime() const { return _end_time; }
double currentTime() const { return _current_time; }
bool successful_time_step = false;
void outputSolutions(bool const output_initial_condition) const;
private:
bool doNonlinearIteration(double const t, double const dt,
std::size_t const timesteps);
/**
* This function fills the vector of solutions of coupled processes of
* processes, _solutions_of_coupled_processes, and initializes the vector
* of solutions of the previous coupling iteration,
* _solutions_of_last_cpl_iteration.
*/
void setCoupledSolutions();
/**
* \brief 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.
*
* @param t Current time
* @param dt Time step size
* @param timestep_id Index of the time step
* @return true: if all nonlinear solvers convergence.
* false: if any of nonlinear solvers divergences.
*/
NumLib::NonlinearSolverStatus solveUncoupledEquationSystems(
const double t, const double dt, const std::size_t timestep_id);
/**
* \brief Member to solver coupled systems of equations by the staggered
* scheme.
*
* @param t Current time
* @param dt Time step size
* @param timestep_id Index of the time step
* @return true: if all nonlinear solvers convergence.
* false: if any of nonlinear solvers divergences.
*/
NumLib::NonlinearSolverStatus solveCoupledEquationSystemsByStaggeredScheme(
const double t, const double dt, const std::size_t timestep_id);
/**
* Find the minimum time step size among the predicted step sizes of
* processes and step it as common time step size.
*
* @param prev_dt Previous time step size.
* @param t Current time.
* @param accepted_steps Accepted time steps that are counted in this
* function.
* @param rejected_steps Rejected time steps that are counted in this
* function.
* @param time_step_constraints Functions that are evaluate to
* influence the time step size (for instance a fixed output time)
* @return the time step size and the information if the last time step was
* rejected
*/
std::pair<double, bool> computeTimeStepping(
const double prev_dt, double& t, std::size_t& accepted_steps,
std::size_t& rejected_steps,
std::vector<std::function<double(double, double)>> const&
time_step_constraints);
template <typename OutputClassMember>
void outputSolutions(bool const output_initial_condition, unsigned timestep,
const double t,
OutputClassMember output_class_member) const;
private:
std::vector<std::function<double(double, double)>>
generateOutputTimeStepConstraints(std::vector<double>&& fixed_times) const;
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 double _start_time;
const double _end_time;
double _current_time = _start_time;
std::size_t _accepted_steps = 0;
std::size_t _rejected_steps = 0;
double _dt = 0;
int _repeating_times_of_rejected_step = 0;
bool _last_step_rejected = false;
/// Maximum iterations of the global coupling.
const int _global_coupling_max_iterations;
/// Convergence criteria of processes for the global coupling iterations.
std::vector<std::unique_ptr<NumLib::ConvergenceCriterion>>
_global_coupling_conv_crit;
/// Solutions of the previous coupling iteration for the convergence
/// criteria of the coupling iteration.
std::vector<GlobalVector*> _solutions_of_last_cpl_iteration;
/// store the ids of the global xdot vectors in the global vector
/// provider for reuse, needed in postTimestepForAllProcesses
/// the length of the vector is the size of _per_process_data
std::vector<std::size_t> _xdot_vector_ids;
};
} // namespace ProcessLib
![swh spinner](/static/img/swh-spinner.gif)
Computing file changes ...