Opm::AdaptiveTimeStepping Class Reference

#include <AdaptiveTimeStepping.hpp>

Public Member Functions
	AdaptiveTimeStepping (const parameter::ParameterGroup &param, const boost::any &pinfo=boost::any(), const bool terminal_output=true)
	contructor taking parameter object More...
template<class Solver , class State , class WellState >
void	step (const SimulatorTimer &timer, Solver &solver, State &state, WellState &well_state)
	step method that acts like the solver::step method in a sub cycle of time steps More...
template<class Solver , class State , class WellState >
void	step (const SimulatorTimer &timer, Solver &solver, State &state, WellState &well_state, OutputWriter &outputWriter)
	step method that acts like the solver::step method in a sub cycle of time steps More...
template<class Solver , class State , class WState >
void	stepImpl (const SimulatorTimer &simulatorTimer, Solver &solver, State &state, WState &well_state, OutputWriter *outputWriter)

Protected Types
typedef std::unique_ptr < TimeStepControlInterface >	TimeStepControlType

Protected Member Functions
template<class Solver , class State , class WellState >
void	stepImpl (const SimulatorTimer &timer, Solver &solver, State &state, WellState &well_state, OutputWriter *outputWriter)

Protected Attributes
TimeStepControlType	timeStepControl_
	time step control object More...
const double	restart_factor_
	factor to multiply time step with when solver fails to converge More...
const double	growth_factor_
	factor to multiply time step when solver recovered from failed convergence More...
const double	max_growth_
	factor that limits the maximum growth of a time step More...
const double	max_time_step_
	maximal allowed time step size More...
const int	solver_restart_max_
	how many restart of solver are allowed More...
const bool	solver_verbose_
	solver verbosity More...
const bool	timestep_verbose_
	timestep verbosity More...
double	suggested_next_timestep_
	suggested size of next timestep More...
bool	full_timestep_initially_
	beginning with the size of the time step from data file More...

Member Typedef Documentation

typedef std::unique_ptr< TimeStepControlInterface > Opm::AdaptiveTimeStepping::TimeStepControlType

protected

Constructor & Destructor Documentation

Opm::AdaptiveTimeStepping::AdaptiveTimeStepping	(	const parameter::ParameterGroup &	param,
		const boost::any &	pinfo = boost::any(),
		const bool	terminal_output = true
	)

contructor taking parameter object

Parameters

param	The parameter object
pinfo	The information about the data distribution and communication for a parallel run.

References Opm::parameter::ParameterGroup::getDefault(), growth_factor_, and timeStepControl_.

Member Function Documentation

template<class Solver , class State , class WellState >

void Opm::AdaptiveTimeStepping::step	(	const SimulatorTimer &	timer,
		Solver &	solver,
		State &	state,
		WellState &	well_state
	)

step method that acts like the solver::step method in a sub cycle of time steps

Parameters

timer	simulator timer providing time and timestep
solver	solver object that must implement a method step( dt, state, well_state )
state	current state of the solution variables
well_state	additional well state object

References stepImpl().

template<class Solver , class State , class WellState >

void Opm::AdaptiveTimeStepping::step	(	const SimulatorTimer &	timer,
		Solver &	solver,
		State &	state,
		WellState &	well_state,
		OutputWriter &	outputWriter
	)

step method that acts like the solver::step method in a sub cycle of time steps

Parameters

timer	simulator timer providing time and timestep
solver	solver object that must implement a method step( dt, state, well_state )
state	current state of the solution variables
well_state	additional well state object
outputWriter	writer object to write sub steps

References stepImpl().

template<class Solver , class State , class WellState >

void Opm::AdaptiveTimeStepping::stepImpl ( const SimulatorTimer &  timer, Solver &  solver, State &  state, WellState &  well_state, OutputWriter *  outputWriter  )

protected

Referenced by step().

template<class Solver , class State , class WState >

void Opm::AdaptiveTimeStepping::stepImpl	(	const SimulatorTimer &	simulatorTimer,
		Solver &	solver,
		State &	state,
		WState &	well_state,
		OutputWriter *	outputWriter
	)

References Opm::AdaptiveSimulatorTimer::currentStepLength(), Opm::SimulatorTimer::currentStepLength(), Opm::AdaptiveSimulatorTimer::currentStepNum(), Opm::unit::day, Opm::AdaptiveSimulatorTimer::done(), full_timestep_initially_, growth_factor_, max_growth_, max_time_step_, Opm::AdaptiveSimulatorTimer::provideTimeStepEstimate(), Opm::AdaptiveSimulatorTimer::report(), restart_factor_, Opm::AdaptiveSimulatorTimer::simulationTimeElapsed(), solver_restart_max_, solver_verbose_, suggested_next_timestep_, timestep_verbose_, timeStepControl_, Opm::unit::convert::to(), and Opm::OutputWriter::writeTimeStep().

Member Data Documentation

bool Opm::AdaptiveTimeStepping::full_timestep_initially_

protected

beginning with the size of the time step from data file

Referenced by stepImpl().

const double Opm::AdaptiveTimeStepping::growth_factor_

protected

factor to multiply time step when solver recovered from failed convergence

Referenced by AdaptiveTimeStepping(), and stepImpl().

const double Opm::AdaptiveTimeStepping::max_growth_

protected

factor that limits the maximum growth of a time step

Referenced by stepImpl().

const double Opm::AdaptiveTimeStepping::max_time_step_

protected

maximal allowed time step size

Referenced by stepImpl().

const double Opm::AdaptiveTimeStepping::restart_factor_

protected

factor to multiply time step with when solver fails to converge

Referenced by stepImpl().

const int Opm::AdaptiveTimeStepping::solver_restart_max_

protected

how many restart of solver are allowed

Referenced by stepImpl().

const bool Opm::AdaptiveTimeStepping::solver_verbose_

protected

solver verbosity

Referenced by stepImpl().

double Opm::AdaptiveTimeStepping::suggested_next_timestep_

protected

suggested size of next timestep

Referenced by stepImpl().

const bool Opm::AdaptiveTimeStepping::timestep_verbose_

protected

timestep verbosity

Referenced by stepImpl().

TimeStepControlType Opm::AdaptiveTimeStepping::timeStepControl_

protected

time step control object

Referenced by AdaptiveTimeStepping(), and stepImpl().

---

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

• AdaptiveTimeStepping.hpp
• AdaptiveTimeStepping_impl.hpp