#include <timesteppers.h>

Inheritance diagram for oomph::TimeStepper:

Public Member Functions
	TimeStepper (const unsigned &tstorage, const unsigned &max_deriv)

	TimeStepper ()
	Broken empty constructor. More...

	TimeStepper (const TimeStepper &)=delete
	Broken copy constructor. More...

void	operator= (const TimeStepper &)=delete
	Broken assignment operator. More...

virtual	~TimeStepper ()
	virtual destructor More...

unsigned	highest_derivative () const
	Highest order derivative that the scheme can compute. More...

virtual unsigned	order () const
	Actual order (accuracy) of the scheme. More...

double &	time ()
	Return current value of continous time. More...

double	time () const
	Return current value of continous time. More...

virtual unsigned	ndt () const =0
	Number of timestep increments that are required by the scheme. More...

virtual unsigned	nprev_values_for_value_at_evaluation_time () const

virtual unsigned	nprev_values () const =0
	Number of previous values available: 0 for static, 1 for BDF<1>,... More...

virtual void	set_weights ()=0

void	make_steady ()

bool	is_steady () const

bool	predict_by_explicit_step () const

ExplicitTimeStepper *	explicit_predictor_pt ()

void	set_predictor_pt (ExplicitTimeStepper *_pred_pt)

void	update_predicted_time (const double &new_time)

void	check_predicted_values_up_to_date () const
	Check that the predicted values are the ones we want. More...

unsigned	predictor_storage_index () const

void	enable_warning_in_assign_initial_data_values ()

void	disable_warning_in_assign_initial_data_values ()

const DenseMatrix< double > *	weights_pt () const
	Get a (const) pointer to the weights. More...

virtual void	undo_make_steady ()

std::string	type () const

void	time_derivative (const unsigned &i, Data *const &data_pt, Vector< double > &deriv)

double	time_derivative (const unsigned &i, Data *const &data_pt, const unsigned &j)
	Evaluate i-th derivative of j-th value in Data. More...

void	time_derivative (const unsigned &i, Node *const &node_pt, Vector< double > &deriv)

double	time_derivative (const unsigned &i, Node *const &node_pt, const unsigned &j)

Time *const &	time_pt () const
	Access function for the pointer to time (const version) More...

Time *&	time_pt ()

virtual double	weight (const unsigned &i, const unsigned &j) const
	Access function for j-th weight for the i-th derivative. More...

unsigned	ntstorage () const

virtual void	assign_initial_values_impulsive (Data *const &data_pt)=0

virtual void	assign_initial_positions_impulsive (Node *const &node_pt)=0

virtual void	shift_time_values (Data *const &data_pt)=0

virtual void	shift_time_positions (Node *const &node_pt)=0

bool	adaptive_flag () const
	Function to indicate whether the scheme is adaptive (false by default) More...

virtual void	set_predictor_weights ()

virtual void	calculate_predicted_values (Data *const &data_pt)

virtual void	calculate_predicted_positions (Node *const &node_pt)

virtual void	set_error_weights ()

virtual double	temporal_error_in_position (Node *const &node_pt, const unsigned &i)

virtual double	temporal_error_in_value (Data *const &data_pt, const unsigned &i)

virtual void	actions_before_timestep (Problem *problem_pt)

virtual void	actions_after_timestep (Problem *problem_pt)

Protected Attributes
Time *	Time_pt
	Pointer to discrete time storage scheme. More...

DenseMatrix< double >	Weight
	Storage for the weights associated with the timestepper. More...

std::string	Type

bool	Adaptive_Flag

bool	Is_steady

bool	Shut_up_in_assign_initial_data_values

bool	Predict_by_explicit_step

ExplicitTimeStepper *	Explicit_predictor_pt

double	Predicted_time

int	Predictor_storage_index

Detailed Description

////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////// Base class for time-stepping schemes. Timestepper provides an approximation of the temporal derivatives of Data such that the i-th derivative of the j-th value in Data is represented as

unsigned n_value=data_pt->nvalue();
Vector<double> time_derivative(n_value);
for (unsigned j=0;j<n_value;j++)
 {
 time_derivative[j]=0.0;
 for (unsigned t=0;t<ntstorage();t++)
  {
   time_derivative[j] += data_pt->value(t,j)*weight(i,t);
  }
 }

where the time index t is such that

t = 0 refers to the current value of the Data
t > 0 refers to the ‘history’ values, i.e. the doubles that are stored in Data to represent the value's time derivatives. For BDF schemes these doubles are the values at previous times; for other timestepping schemes they can represent quantities such as previous first and second derivatives, etc.

TimeSteppers can evaluate all derivatives up to their order().

The first nprev_values() ‘history values’ represent the values at the previous timesteps. For BDF schemes, nprev_values() = ntstorage()-1 , i.e. all ‘history values’ represent previous values. For Newmark<NSTEPS>, only the first NSTEPS ‘history values’ represent previous values (NSTEPS=1 gives the normal Newmark scheme).

Constructor & Destructor Documentation

◆ TimeStepper() [1/3]

oomph::TimeStepper::TimeStepper	(	const unsigned &	tstorage,
		const unsigned &	max_deriv
	)

inline

Constructor. Pass the amount of storage required by timestepper (present value + history values) and the order of highest time-derivative.

       : Time_pt(0),
         Adaptive_Flag(false),
         Is_steady(false),
         Shut_up_in_assign_initial_data_values(false),
         Predict_by_explicit_step(false)
     {
       // Resize Weights matrix and initialise each weight to zero
       Weight.resize(max_deriv + 1, tstorage, 0.0);
  
       // Set the weight for zero-th derivative, which is always 1.0
       Weight(0, 0) = 1.0;
  
       // Set predictor storage index to negative value so that we can catch
       // cases where it has not been set to a correct value by the inheriting
       // constructor.
       Predictor_storage_index = -1;
  
       Explicit_predictor_pt = 0;
     }

References ProblemParameters::Weight.

◆ TimeStepper() [2/3]

oomph::TimeStepper::TimeStepper ( )

inline

Broken empty constructor.

     {
       throw OomphLibError("Don't call default constructor for TimeStepper!",
                           OOMPH_CURRENT_FUNCTION,
                           OOMPH_EXCEPTION_LOCATION);
     }

References OOMPH_CURRENT_FUNCTION, and OOMPH_EXCEPTION_LOCATION.

◆ TimeStepper() [3/3]

oomph::TimeStepper::TimeStepper ( const TimeStepper & )

delete

Broken copy constructor.

◆ ~TimeStepper()

oomph::TimeStepper::~TimeStepper ( )

virtual

virtual destructor

Destructor for time stepper, in .cc file so that we don't have to include explicit_timesteppers.h in header.

   {
     // Make sure explicit predictor gets deleted if it was set
     delete Explicit_predictor_pt;
     Explicit_predictor_pt = 0;
   }

References Explicit_predictor_pt.

Member Function Documentation

◆ actions_after_timestep()

virtual void oomph::TimeStepper::actions_after_timestep ( Problem * problem_pt )

inlinevirtual

Interface for any actions that need to be performed after a time step.

Reimplemented in oomph::TR, and oomph::IMRByBDF.

666 {}

Referenced by oomph::Problem::adaptive_unsteady_newton_solve(), and oomph::Problem::unsteady_newton_solve().

◆ actions_before_timestep()

virtual void oomph::TimeStepper::actions_before_timestep ( Problem * problem_pt )

inlinevirtual

Interface for any actions that need to be performed before a time step.

Reimplemented in oomph::TR, and oomph::IMRByBDF.

662 {}

Referenced by oomph::Problem::adaptive_unsteady_newton_solve(), and oomph::Problem::unsteady_newton_solve().

◆ adaptive_flag()

bool oomph::TimeStepper::adaptive_flag ( ) const

inline

Function to indicate whether the scheme is adaptive (false by default)

     {
       return Adaptive_Flag;
     }

◆ assign_initial_positions_impulsive()

virtual void oomph::TimeStepper::assign_initial_positions_impulsive ( Node *const & node_pt )

pure virtual

Initialiset the positions for the node corresponding to an impulsive start

Implemented in oomph::TR, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::Newmark< NSTEPS >, oomph::Newmark< 2 >, oomph::Steady< NSTEPS >, oomph::Steady< 0 >, oomph::Steady< 2 >, oomph::PeriodicOrbitTimeDiscretisation, oomph::IMRBase, oomph::ContinuationStorageScheme, and oomph::SelfStartingBDF2.

◆ assign_initial_values_impulsive()

virtual void oomph::TimeStepper::assign_initial_values_impulsive ( Data *const & data_pt )

pure virtual

Initialise the time-history for the Data values corresponding to an impulsive start.

Implemented in oomph::TR, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::Newmark< NSTEPS >, oomph::Newmark< 2 >, oomph::Steady< NSTEPS >, oomph::Steady< 0 >, oomph::Steady< 2 >, oomph::PeriodicOrbitTimeDiscretisation, oomph::IMRBase, oomph::ContinuationStorageScheme, and oomph::SelfStartingBDF2.

Referenced by oomph::Circle::Circle().

◆ calculate_predicted_positions()

virtual void oomph::TimeStepper::calculate_predicted_positions ( Node *const & node_pt )

inlinevirtual

Do the predictor step for the positions at a node (currently empty — overwrite for a specific scheme)

Reimplemented in oomph::TR, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, and oomph::IMRBase.

638 {}

◆ calculate_predicted_values()

virtual void oomph::TimeStepper::calculate_predicted_values ( Data *const & data_pt )

inlinevirtual

Do the predictor step for data stored in a Data object (currently empty – overwrite for specific scheme)

Reimplemented in oomph::TR, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, and oomph::IMRBase.

634 {}

◆ check_predicted_values_up_to_date()

void oomph::TimeStepper::check_predicted_values_up_to_date ( ) const

inline

Check that the predicted values are the ones we want.

     {
 #ifdef PARANOID
       if (std::abs(time_pt()->time() - Predicted_time) > 1e-15)
       {
         throw OomphLibError(
           "Predicted values are not from the correct time step",
           OOMPH_EXCEPTION_LOCATION,
           OOMPH_CURRENT_FUNCTION);
       }
 #endif
     }

References abs(), e(), OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION, and oomph::Time::time().

Referenced by oomph::IMRBase::calculate_predicted_values().

◆ disable_warning_in_assign_initial_data_values()

void oomph::TimeStepper::disable_warning_in_assign_initial_data_values ( )

inline

Disable the output of warnings due to possible fct pointer vector size mismatch in assign_initial_data_values

     {
       Shut_up_in_assign_initial_data_values = true;
     }

◆ enable_warning_in_assign_initial_data_values()

void oomph::TimeStepper::enable_warning_in_assign_initial_data_values ( )

inline

Enable the output of warnings due to possible fct pointer vector size mismatch in assign_initial_data_values (Default)

     {
       Shut_up_in_assign_initial_data_values = false;
     }

◆ explicit_predictor_pt()

ExplicitTimeStepper* oomph::TimeStepper::explicit_predictor_pt ( )

inline

Get the pointer to the explicit timestepper to use as a predictor in adaptivity if Predict_by_explicit_step is set.

     {
       return Explicit_predictor_pt;
     }

Referenced by oomph::Problem::calculate_predictions().

◆ highest_derivative()

unsigned oomph::TimeStepper::highest_derivative ( ) const

inline

Highest order derivative that the scheme can compute.

     {
       return Weight.nrow() - 1;
     }

References ProblemParameters::Weight.

◆ is_steady()

bool oomph::TimeStepper::is_steady ( ) const

inline

Flag to indicate if a timestepper has been made steady (possibly temporarily to switch off time-dependence)

     {
       return Is_steady;
     }

◆ make_steady()

void oomph::TimeStepper::make_steady ( )

inline

Function to make the time stepper temporarily steady. This is trivially achieved by setting all the weights to zero

     {
       // Zero the matrix
       Weight.initialise(0);
  
       // Weight of current step in calculation of current step is always 1 in
       // steady state. All other entries left at zero.
       Weight(0, 0) = 1.0;
  
       // Update flag
       Is_steady = true;
     }

References ProblemParameters::Weight.

Referenced by oomph::Problem::arc_length_step_solve_helper(), FlowAroundCylinderProblem< ELEMENT >::FlowAroundCylinderProblem(), oomph::Problem::get_dvaluesdt(), oomph::Problem::solve_eigenproblem(), oomph::Problem::steady_newton_solve(), and oomph::SegregatableFSIProblem::steady_segregated_solve().

◆ ndt()

virtual unsigned oomph::TimeStepper::ndt ( ) const

pure virtual

Number of timestep increments that are required by the scheme.

Implemented in oomph::TR, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::Newmark< NSTEPS >, oomph::Newmark< 2 >, oomph::Steady< NSTEPS >, oomph::Steady< 0 >, oomph::Steady< 2 >, oomph::PeriodicOrbitTimeDiscretisation, oomph::IMRBase, oomph::ContinuationStorageScheme, and oomph::SelfStartingBDF2.

Referenced by oomph::Problem::add_time_stepper_pt().

◆ nprev_values()

virtual unsigned oomph::TimeStepper::nprev_values ( ) const

pure virtual

Number of previous values available: 0 for static, 1 for BDF<1>,...

Implemented in oomph::TR, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::Newmark< NSTEPS >, oomph::Newmark< 2 >, oomph::Steady< NSTEPS >, oomph::Steady< 0 >, oomph::Steady< 2 >, oomph::PeriodicOrbitTimeDiscretisation, oomph::IMRBase, oomph::ContinuationStorageScheme, and oomph::SelfStartingBDF2.

Referenced by SurfactantProblem< ELEMENT, INTERFACE_ELEMENT >::actions_after_adapt(), oomph::AlgebraicCollapsibleChannelMesh< ELEMENT >::algebraic_node_update(), oomph::AlgebraicFSIDrivenCavityMesh< ELEMENT >::algebraic_node_update(), AxisymmetricVibratingShellProblem< ELEMENT >::complete_problem_setup(), VibratingShellProblem< ELEMENT >::complete_problem_setup(), TwoLayerInterfaceProblem< ELEMENT >::complete_problem_setup(), UnstructuredFluidProblem< ELEMENT >::complete_problem_setup(), BubbleInChannelProblem< ELEMENT >::complete_problem_setup(), DropInChannelProblem< ELEMENT >::complete_problem_setup(), oomph::RefineablePolarTaylorHoodElement::get_interpolated_values(), oomph::RefineablePolarCrouzeixRaviartElement::get_interpolated_values(), oomph::FiniteElement::get_x(), oomph::ODEProblem::my_set_initial_condition(), oomph::AlgebraicNode::node_update(), oomph::MacroElementNodeUpdateNode::node_update(), oomph::AlgebraicRefineableQuarterTubeMesh< ELEMENT >::node_update_central_region(), oomph::AlgebraicRefineableQuarterCircleSectorMesh< ELEMENT >::node_update_in_central_box(), oomph::AlgebraicRefineableQuarterCircleSectorMesh< ELEMENT >::node_update_in_lower_right_box(), oomph::AlgebraicRefineableQuarterCircleSectorMesh< ELEMENT >::node_update_in_upper_left_box(), oomph::AlgebraicRefineableQuarterTubeMesh< ELEMENT >::node_update_lower_right_region(), oomph::AlgebraicRefineableQuarterTubeMesh< ELEMENT >::node_update_upper_left_region(), oomph::PseudoBucklingRing::position(), oomph::PseudoBucklingRing::PseudoBucklingRing(), oomph::ImmersedRigidBodyTriangleMeshPolygon::reset_reference_configuration(), UnstructuredImmersedEllipseProblem< ELEMENT >::set_boundary_velocity(), AdvectionProblem::set_initial_conditions(), EulerProblem::set_initial_conditions(), oomph::SolidICProblem::set_newmark_initial_condition_consistently(), oomph::TetMeshBase::snap_nodes_onto_geometric_objects(), and oomph::UnstructuredTwoDMeshGeometryBase::snap_nodes_onto_geometric_objects().

◆ nprev_values_for_value_at_evaluation_time()

virtual unsigned oomph::TimeStepper::nprev_values_for_value_at_evaluation_time ( ) const

inlinevirtual

Number of previous values needed to calculate the value at the current time. i.e. how many previous values must we loop over to calculate the values at the evaluation time. For most methods this is 1, i.e. just use the value at t_{n+1}. See midpoint method for a counter-example.

Reimplemented in oomph::IMRBase, oomph::IMRByBDF, and oomph::IMR.

     {
       return 1;
     }

Referenced by oomph::IMRODEElement::time_interpolate_time(), and oomph::IMRODEElement::time_interpolate_u().

◆ ntstorage()

unsigned oomph::TimeStepper::ntstorage ( ) const

inline

Return the number of doubles required to represent history (one for steady)

     {
       return (Weight.ncol());
     }

References ProblemParameters::Weight.

◆ operator=()

void oomph::TimeStepper::operator= ( const TimeStepper & )

delete

Broken assignment operator.

◆ order()

virtual unsigned oomph::TimeStepper::order ( ) const

inlinevirtual

Actual order (accuracy) of the scheme.

Reimplemented in oomph::TR, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::Newmark< NSTEPS >, oomph::Newmark< 2 >, oomph::Steady< NSTEPS >, oomph::Steady< 0 >, oomph::Steady< 2 >, oomph::PeriodicOrbitTimeDiscretisation, oomph::IMRBase, oomph::ContinuationStorageScheme, and oomph::SelfStartingBDF2.

     {
       return 0;
     }

◆ predict_by_explicit_step()

bool oomph::TimeStepper::predict_by_explicit_step ( ) const

inline

Flag: is adaptivity done by taking a separate step using an ExplicitTimeStepper object?

     {
       return Predict_by_explicit_step;
     }

◆ predictor_storage_index()

unsigned oomph::TimeStepper::predictor_storage_index ( ) const

inline

Return the time-index in each Data where predicted values are stored if the timestepper is adaptive.

     {
       // Error if time stepper is non-adaptive (because then the index doesn't
       // exist so using it would give a potentially difficult to find
       // segault).
 #ifdef PARANOID
       if (Predictor_storage_index > 0)
       {
         return unsigned(Predictor_storage_index);
       }
       else
       {
         std::string err = "Predictor storage index is negative, this probably";
         err += " means it hasn't been set for this timestepper.";
         throw OomphLibError(
           err, OOMPH_EXCEPTION_LOCATION, OOMPH_CURRENT_FUNCTION);
       }
 #else
       return unsigned(Predictor_storage_index);
 #endif
     }

References OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION, and oomph::Global_string_for_annotation::string().

◆ set_error_weights()

virtual void oomph::TimeStepper::set_error_weights ( )

inlinevirtual

Set the weights for the error computation, (currently empty – overwrite for specific scheme)

Reimplemented in oomph::TR, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, and oomph::IMRBase.

642 {}

Referenced by oomph::Problem::adaptive_unsteady_newton_solve(), and oomph::Problem::initialise_dt().

◆ set_predictor_pt()

void oomph::TimeStepper::set_predictor_pt ( ExplicitTimeStepper * _pred_pt )

inline

Set the pointer to the explicit timestepper to use as a predictor in adaptivity if Predict_by_explicit_step is set.

     {
       Explicit_predictor_pt = _pred_pt;
     }

Referenced by oomph::Factories::time_stepper_factory().

◆ set_predictor_weights()

virtual void oomph::TimeStepper::set_predictor_weights ( )

inlinevirtual

Set the weights for the predictor previous timestep (currently empty – overwrite for specific scheme)

Reimplemented in oomph::TR, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, and oomph::IMRBase.

630 {}

Referenced by oomph::Problem::adaptive_unsteady_newton_solve().

◆ set_weights()

virtual void oomph::TimeStepper::set_weights ( )

pure virtual

Function to set the weights for present timestep (don't need to pass present timestep or previous timesteps as they are available via Time_pt)

Referenced by oomph::Problem::adaptive_unsteady_newton_solve(), oomph::Problem::copy(), oomph::Problem::initialise_dt(), oomph::Problem::unsteady_newton_solve(), and oomph::SegregatableFSIProblem::unsteady_segregated_solve().

◆ shift_time_positions()

virtual void oomph::TimeStepper::shift_time_positions ( Node *const & node_pt )

pure virtual

This function advances the time history of the positions at a node. The default should be OK, but would need to be overloaded

Implemented in oomph::TR, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::NewmarkBDF< NSTEPS >, oomph::Newmark< NSTEPS >, oomph::Newmark< 2 >, oomph::Steady< NSTEPS >, oomph::Steady< 0 >, oomph::Steady< 2 >, oomph::PeriodicOrbitTimeDiscretisation, oomph::IMRBase, oomph::ContinuationStorageScheme, and oomph::SelfStartingBDF2.

◆ shift_time_values()

virtual void oomph::TimeStepper::shift_time_values ( Data *const & data_pt )

pure virtual

This function advances the Data's time history so that we can move on to the next timestep

Implemented in oomph::TR, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::NewmarkBDF< NSTEPS >, oomph::Newmark< NSTEPS >, oomph::Newmark< 2 >, oomph::Steady< NSTEPS >, oomph::Steady< 0 >, oomph::Steady< 2 >, oomph::PeriodicOrbitTimeDiscretisation, oomph::IMRBase, oomph::ContinuationStorageScheme, and oomph::SelfStartingBDF2.

◆ temporal_error_in_position()

virtual double oomph::TimeStepper::temporal_error_in_position	(	Node *const &	node_pt,
		const unsigned &	i
	)

inlinevirtual

Compute the error in the position i at a node zero here – overwrite for specific scheme.

Reimplemented in oomph::TR, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, and oomph::IMRBase.

     {
       return 0.0;
     }

◆ temporal_error_in_value()

virtual double oomph::TimeStepper::temporal_error_in_value	(	Data *const &	data_pt,
		const unsigned &	i
	)

inlinevirtual

Compute the error in the value i in a Data structure zero here – overwrite for specific scheme.

Reimplemented in oomph::TR, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, oomph::BDF< NSTEPS >, oomph::BDF< 2 >, and oomph::IMRBase.

     {
       return 0.0;
     }

◆ time() [1/2]

double& oomph::TimeStepper::time ( )

inline

Return current value of continous time.

     {
       return Time_pt->time();
     }

References Flag_definition::Time_pt.

Referenced by oomph::SelfStartingBDF2::assign_initial_data_values(), oomph::PeriodicOrbitTimeDiscretisation::assign_initial_data_values(), oomph::ODEElement::fill_in_contribution_to_jacobian(), oomph::ODEElement::fill_in_contribution_to_residuals(), oomph::PerturbedSpineLinearisedAxisymmetricFluidInterfaceElement< ELEMENT >::fill_in_generic_residual_contribution_interface(), oomph::LinearisedAxisymmetricNavierStokesEquations::fill_in_generic_residual_contribution_lin_axi_nst(), oomph::LinearisedNavierStokesEquations::fill_in_generic_residual_contribution_linearised_nst(), oomph::RefineableLinearisedNavierStokesEquations::fill_in_generic_residual_contribution_linearised_nst(), oomph::ImmersedRigidBodyElement::get_residuals_rigid_body_generic(), and oomph::ImmersedRigidBodyElement::output_centre_of_gravity().

◆ time() [2/2]

double oomph::TimeStepper::time ( ) const

inline

Return current value of continous time.

     {
 #ifdef PARANOID
       if (Time_pt == 0)
       {
         std::string error_msg = "Time pointer is null!";
         throw OomphLibError(
           error_msg, OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION);
       }
 #endif
       return Time_pt->time();
     }

References OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION, oomph::Global_string_for_annotation::string(), and Flag_definition::Time_pt.

◆ time_derivative() [1/4]

double oomph::TimeStepper::time_derivative	(	const unsigned &	i,
		Data *const &	data_pt,
		const unsigned &	j
	)

inline

Evaluate i-th derivative of j-th value in Data.

     {
       double deriv = 0.0;
       unsigned n_tstorage = ntstorage();
       // Loop over all history data and add the appropriate contribution
       // to the derivative
       for (unsigned t = 0; t < n_tstorage; t++)
       {
         deriv += Weight(i, t) * data_pt->value(t, j);
       }
       return deriv;
     }

References i, j, plotPSD::t, oomph::Data::value(), and ProblemParameters::Weight.

◆ time_derivative() [2/4]

void oomph::TimeStepper::time_derivative	(	const unsigned &	i,
		Data *const &	data_pt,
		Vector< double > &	deriv
	)

inline

Evaluate i-th derivative of all values in Data and return in Vector deriv[].

     {
       // Number of values stored in the Data object
       unsigned nvalue = data_pt->nvalue();
       deriv.assign(nvalue, 0.0);
  
       // Loop over all values
       for (unsigned j = 0; j < nvalue; j++)
       {
         deriv[j] = time_derivative(i, data_pt, j);
       }
     }

References i, j, and oomph::Data::nvalue().

Referenced by oomph::ImmersedRigidBodyElement::dposition_dt(), oomph::IMRODEElement::fill_in_contribution_to_residuals(), oomph::ODEElement::fill_in_contribution_to_residuals(), oomph::ImmersedRigidBodyElement::get_residuals_rigid_body_generic(), oomph::ImmersedRigidBodyElement::output_centre_of_gravity(), and oomph::SelfStartingBDF2::shift_time_values().

◆ time_derivative() [3/4]

double oomph::TimeStepper::time_derivative	(	const unsigned &	i,
		Node *const &	node_pt,
		const unsigned &	j
	)

inline

Evaluate i-th derivative of j-th value in Node. Note the use of the node's value() function so that hanging nodes are taken into account (this is why the functions for Data and Node cannot be combined through simple polymorphism: value is not virtual).

     {
       double deriv = 0.0;
       unsigned n_tstorage = ntstorage();
       // Loop over all history data and add the appropriate contribution
       // to the derivative
       for (unsigned t = 0; t < n_tstorage; t++)
       {
         deriv += weight(i, t) * node_pt->value(t, j);
       }
       return deriv;
     }

References i, j, plotPSD::t, and oomph::Node::value().

◆ time_derivative() [4/4]

void oomph::TimeStepper::time_derivative	(	const unsigned &	i,
		Node *const &	node_pt,
		Vector< double > &	deriv
	)

inline

Evaluate i-th derivative of all values in Node and return in Vector deriv[] (this can't be simply combined with time_derivative(.., Data, ...) because of differences with haning nodes).

     {
       // Number of values stored in the Data object
       unsigned nvalue = node_pt->nvalue();
       deriv.assign(nvalue, 0.0);
  
       // Loop over all values
       for (unsigned j = 0; j < nvalue; j++)
       {
         deriv[j] = time_derivative(i, node_pt, j);
       }
     }

References i, j, and oomph::Data::nvalue().

◆ time_pt() [1/2]

Time*& oomph::TimeStepper::time_pt ( )

inline

Access function for the pointer to time (can't have a paranoid test for null pointers because this is used as a set function).

     {
       return Time_pt;
     }

References Flag_definition::Time_pt.

◆ time_pt() [2/2]

Time* const& oomph::TimeStepper::time_pt ( ) const

inline

Access function for the pointer to time (const version)

     {
 #ifdef PARANOID
       if (Time_pt == 0)
       {
         std::string error_msg(
           "Time_pt is null, probably because it is a steady time stepper.");
         throw OomphLibError(
           error_msg, OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION);
       }
 #endif
       return Time_pt;
     }

References OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION, oomph::Global_string_for_annotation::string(), and Flag_definition::Time_pt.

◆ type()

std::string oomph::TimeStepper::type ( ) const

inline

Return string that indicates the type of the timestepper (e.g. "BDF", "Newmark", etc.)

     {
       return Type;
     }

Referenced by ElasticAxisymmetricSolubleSurfactantTransportInterfaceElement< ELEMENT >::dc_bulk_dt_surface(), oomph::SpineAxisymmetricMarangoniSurfactantFluidInterfaceElement< ELEMENT >::dcdt_surface(), oomph::SpineLineMarangoniSurfactantFluidInterfaceElement< ELEMENT >::dcdt_surface(), oomph::SurfactantTransportInterfaceElement::dcdt_surface(), SSPorousChannelEquations::df_dt(), SpineGravityTractionElement< ELEMENT >::du_dt(), oomph::PolarNavierStokesEquations::du_dt_pnst(), oomph::SphericalNavierStokesEquations::du_dt_spherical_nst(), and oomph::SolidFiniteElement::fill_in_jacobian_for_newmark_accel().

◆ undo_make_steady()

virtual void oomph::TimeStepper::undo_make_steady ( )

inlinevirtual

Reset the is_steady status of a specific TimeStepper to its default and re-assign the weights.

Reimplemented in oomph::ContinuationStorageScheme, and oomph::SelfStartingBDF2.

     {
       Is_steady = false;
       set_weights();
     }

Referenced by oomph::Problem::arc_length_step_solve_helper(), oomph::Problem::get_dvaluesdt(), oomph::Problem::solve_eigenproblem(), oomph::Problem::steady_newton_solve(), and oomph::SegregatableFSIProblem::steady_segregated_solve().

◆ update_predicted_time()

void oomph::TimeStepper::update_predicted_time ( const double & new_time )

inline

Set the time that the current predictions apply for, only needed for paranoid checks when doing Predict_by_explicit_step.

     {
       Predicted_time = new_time;
     }

Referenced by oomph::Problem::calculate_predictions().

◆ weight()

virtual double oomph::TimeStepper::weight	(	const unsigned &	i,
		const unsigned &	j
	)		const

inlinevirtual

Access function for j-th weight for the i-th derivative.

Reimplemented in oomph::Steady< NSTEPS >, oomph::Steady< 0 >, and oomph::Steady< 2 >.

     {
       return Weight(i, j);
     }

References i, j, and ProblemParameters::Weight.

◆ weights_pt()

const DenseMatrix<double>* oomph::TimeStepper::weights_pt ( ) const

inline

Get a (const) pointer to the weights.

     {
       return &Weight;
     }

References ProblemParameters::Weight.

Member Data Documentation

◆ Adaptive_Flag

bool oomph::TimeStepper::Adaptive_Flag

protected

Boolean variable to indicate whether the timestepping scheme can be adaptive

Referenced by oomph::IMRBase::IMRBase(), oomph::SelfStartingBDF2::SelfStartingBDF2(), and oomph::TR::TR().

◆ Explicit_predictor_pt

ExplicitTimeStepper* oomph::TimeStepper::Explicit_predictor_pt

protected

Pointer to explicit time stepper to use as predictor if Predict_by_explicit_step is set. ??ds merge the two? predict by explicit if pointer is set?

Referenced by ~TimeStepper().

◆ Is_steady

bool oomph::TimeStepper::Is_steady

protected

Bool to indicate if the timestepper is steady, i.e. its time-derivatives evaluate to zero. This status may be achieved temporarily by calling make_steady(). It can be reset to the appropriate default by the function undo_make_steady().

Referenced by oomph::ContinuationStorageScheme::ContinuationStorageScheme(), oomph::IMRBase::IMRBase(), oomph::SelfStartingBDF2::undo_make_steady(), and oomph::ContinuationStorageScheme::undo_make_steady().

◆ Predict_by_explicit_step

bool oomph::TimeStepper::Predict_by_explicit_step

protected

Flag: is adaptivity done by taking a separate step using an ExplicitTimeStepper object?

Referenced by oomph::IMRBase::IMRBase().

◆ Predicted_time

double oomph::TimeStepper::Predicted_time

protected

Store the time that the predicted values currently stored are at, to compare for paranoid checks.

◆ Predictor_storage_index

int oomph::TimeStepper::Predictor_storage_index

protected

The time-index in each Data object where predicted values are stored. -1 if not set.

Referenced by oomph::IMRBase::IMRBase(), and oomph::IMRBase::temporal_error_in_value().

◆ Shut_up_in_assign_initial_data_values

bool oomph::TimeStepper::Shut_up_in_assign_initial_data_values

protected

Boolean to indicate if the timestepper will output warnings when setting possibly an incorrect number of initial data values from function pointers

◆ Time_pt

Time* oomph::TimeStepper::Time_pt

protected

Pointer to discrete time storage scheme.

Referenced by oomph::SelfStartingBDF2::assign_initial_data_values(), oomph::PeriodicOrbitTimeDiscretisation::assign_initial_data_values(), oomph::TR::set_error_weights(), oomph::SelfStartingBDF2::set_error_weights_bdf2(), oomph::TR::set_predictor_weights(), oomph::SelfStartingBDF2::set_predictor_weights_bdf2(), oomph::IMR::set_weights(), oomph::IMRByBDF::set_weights(), oomph::TR::set_weights(), oomph::SelfStartingBDF2::set_weights_bdf1(), and oomph::SelfStartingBDF2::set_weights_bdf2().

◆ Type

std::string oomph::TimeStepper::Type

protected

String that indicates the type of the timestepper (e.g. "BDF", "Newmark", etc.)

Referenced by oomph::ContinuationStorageScheme::ContinuationStorageScheme(), oomph::IMRBase::IMRBase(), oomph::PeriodicOrbitTimeDiscretisation::PeriodicOrbitTimeDiscretisation(), and oomph::SelfStartingBDF2::SelfStartingBDF2().

◆ Weight

DenseMatrix<double> oomph::TimeStepper::Weight

protected

Storage for the weights associated with the timestepper.

Referenced by oomph::IMRBase::IMRBase(), oomph::ContinuationStorageScheme::modify_storage(), oomph::SelfStartingBDF2::SelfStartingBDF2(), oomph::PeriodicOrbitEquations::set_timestepper_weights(), oomph::IMR::set_weights(), oomph::IMRByBDF::set_weights(), oomph::TR::set_weights(), oomph::SelfStartingBDF2::set_weights_bdf1(), oomph::SelfStartingBDF2::set_weights_bdf2(), oomph::SelfStartingBDF2::shift_time_positions(), oomph::IMRBase::shift_time_positions(), and oomph::TR::TR().

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TimeStepper() [1/3]

◆ TimeStepper() [2/3]

◆ TimeStepper() [3/3]

◆ ~TimeStepper()

Member Function Documentation

◆ actions_after_timestep()

◆ actions_before_timestep()

◆ adaptive_flag()

◆ assign_initial_positions_impulsive()

◆ assign_initial_values_impulsive()

◆ calculate_predicted_positions()

◆ calculate_predicted_values()

◆ check_predicted_values_up_to_date()

◆ disable_warning_in_assign_initial_data_values()

◆ enable_warning_in_assign_initial_data_values()

◆ explicit_predictor_pt()

◆ highest_derivative()

◆ is_steady()

◆ make_steady()

◆ ndt()

◆ nprev_values()

◆ nprev_values_for_value_at_evaluation_time()

◆ ntstorage()

◆ operator=()

◆ order()

◆ predict_by_explicit_step()

◆ predictor_storage_index()

◆ set_error_weights()

◆ set_predictor_pt()

◆ set_predictor_weights()

◆ set_weights()

◆ shift_time_positions()

◆ shift_time_values()

◆ temporal_error_in_position()

◆ temporal_error_in_value()

◆ time() [1/2]

◆ time() [2/2]

◆ time_derivative() [1/4]

◆ time_derivative() [2/4]

◆ time_derivative() [3/4]

◆ time_derivative() [4/4]

◆ time_pt() [1/2]

◆ time_pt() [2/2]

◆ type()

◆ undo_make_steady()

◆ update_predicted_time()

◆ weight()

◆ weights_pt()

Member Data Documentation

◆ Adaptive_Flag

◆ Explicit_predictor_pt

◆ Is_steady

◆ Predict_by_explicit_step

◆ Predicted_time

◆ Predictor_storage_index

◆ Shut_up_in_assign_initial_data_values

◆ Time_pt

◆ Type

◆ Weight