#include <implicit_midpoint_rule.h>

Inheritance diagram for oomph::IMRByBDF:

Public Member Functions
	IMRByBDF (const bool &adaptive=false)
	Constructor with initialisation. More...

virtual	~IMRByBDF ()
	Destructor. More...

void	set_weights ()
	Setup weights for time derivative calculations. More...

unsigned	nprev_values_for_value_at_evaluation_time () const
	Number of history values to interpolate over to get the "current" value. Evaluation time is the end of the bdf1 "half-step", so only need one value as normal. More...

void	actions_before_timestep (Problem *problem_pt)
	Half the timestep before starting solve. More...

void	actions_after_timestep (Problem *problem_pt)

Public Member Functions inherited from oomph::IMRBase
	IMRBase (const bool &adaptive=false)
	Constructor with initialisation. More...

virtual	~IMRBase ()
	Destructor. More...

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

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

unsigned	nprev_values () const
	??ds More...

void	shift_time_values (Data *const &data_pt)
	This function advances the Data's time history so that we can move on to the next timestep. More...

void	shift_time_positions (Node *const &node_pt)
	This function advances the time history of the positions at a node. More...

void	set_error_weights ()
	Set the weights for the error computation. This is not used by midpoint rule. More...

void	set_predictor_weights ()
	Set the weights for the predictor previous timestep. This is not used by midpint rule. More...

void	assign_initial_values_impulsive (Data *const &data_pt)
	not implemented (??ds TODO) More...

void	assign_initial_positions_impulsive (Node *const &node_pt)
	Initialiset the positions for the node corresponding to an impulsive start. More...

void	calculate_predicted_positions (Node *const &node_pt)
	Do the predictor step for the positions at a node (currently empty — overwrite for a specific scheme) More...

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

void	calculate_predicted_values (Data *const &data_pt)

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

Public Member Functions inherited from oomph::TimeStepper
	TimeStepper (const unsigned &tstorage, const unsigned &max_deriv)
	Constructor. Pass the amount of storage required by timestepper (present value + history values) and the order of highest time-derivative. More...

	TimeStepper ()
	Broken empty constructor. More...

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

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

virtual	~TimeStepper ()
	virtual destructor More...

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

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

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

void	make_steady ()
	Function to make the time stepper temporarily steady. This is trivially achieved by setting all the weights to zero. More...

bool	is_steady () const
	Flag to indicate if a timestepper has been made steady (possibly temporarily to switch off time-dependence) More...

bool	predict_by_explicit_step () const
	Flag: is adaptivity done by taking a separate step using an ExplicitTimeStepper object? More...

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
	Return the time-index in each Data where predicted values are stored if the timestepper is adaptive. More...

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

void	disable_warning_in_assign_initial_data_values ()
	Disable the output of warnings due to possible fct pointer vector size mismatch in assign_initial_data_values. More...

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

virtual void	undo_make_steady ()
	Reset the is_steady status of a specific TimeStepper to its default and re-assign the weights. More...

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

void	time_derivative (const unsigned &i, Data *const &data_pt, Vector< double > &deriv)
	Evaluate i-th derivative of all values in Data and return in Vector deriv[]. More...

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)
	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). More...

double	time_derivative (const unsigned &i, Node *const &node_pt, const unsigned &j)
	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). More...

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
	Return the number of doubles required to represent history (one for steady) More...

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

Public Attributes
bool	Update_pinned
	Should we update pinned variables after the half-step? More...

Private Member Functions
	IMRByBDF (const IMRByBDF &dummy)
	Inaccessible copy constructor. More...

void	operator= (const IMRByBDF &dummy)
	Inaccessible assignment operator. More...

Additional Inherited Members
Protected Attributes inherited from oomph::TimeStepper
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
	String that indicates the type of the timestepper (e.g. "BDF", "Newmark", etc.) More...

bool	Adaptive_Flag
	Boolean variable to indicate whether the timestepping scheme can be adaptive. More...

bool	Is_steady
	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(). More...

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

bool	Predict_by_explicit_step
	Flag: is adaptivity done by taking a separate step using an ExplicitTimeStepper object? More...

ExplicitTimeStepper *	Explicit_predictor_pt

double	Predicted_time

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

Detailed Description

Implementation of implicit midpoint rule by taking half a step of bdf1 then applying an update to all dofs. This implementation should work with any existing problem for which the BDF methods work.

The exception is when multiple different time steppers are being used simultaneously for different parts of the problem. In this case the IMR class should be used.

Definition at line 214 of file implicit_midpoint_rule.h.

Constructor & Destructor Documentation

◆ IMRByBDF() [1/2]

oomph::IMRByBDF::IMRByBDF ( const bool & adaptive = false )

inline

Constructor with initialisation.

Definition at line 218 of file implicit_midpoint_rule.h.

◆ ~IMRByBDF()

virtual oomph::IMRByBDF::~IMRByBDF ( )

inlinevirtual

Destructor.

Definition at line 224 of file implicit_midpoint_rule.h.

◆ IMRByBDF() [2/2]

oomph::IMRByBDF::IMRByBDF ( const IMRByBDF & dummy )

inlineprivate

Inaccessible copy constructor.

Definition at line 253 of file implicit_midpoint_rule.h.

Member Function Documentation

◆ actions_after_timestep()

void oomph::IMRByBDF::actions_after_timestep ( Problem * problem_pt )

virtual

Take problem from t={n+1/2} to t=n+1 by algebraic update and restore time step.

Reimplemented from oomph::TimeStepper.

Definition at line 208 of file implicit_midpoint_rule.cc.

References oomph::Time::dt(), e, oomph::Mesh::element_pt(), oomph::Problem::get_dofs(), oomph::Problem::global_data_pt(), i, oomph::GeneralisedElement::internal_data_pt(), oomph::Problem::mesh_pt(), oomph::Problem::ndof(), oomph::Mesh::nelement(), oomph::Problem::nglobal_data(), oomph::GeneralisedElement::ninternal_data(), oomph::Mesh::nnode(), oomph::Mesh::node_pt(), oomph::DistributableLinearAlgebraObject::nrow(), oomph::post_midpoint_update(), oomph::Global_string_for_annotation::string(), oomph::Time::time(), oomph::Problem::time_pt(), and oomph::StringConversion::to_string().

◆ actions_before_timestep()

void oomph::IMRByBDF::actions_before_timestep ( Problem * problem_pt )

virtual

Half the timestep before starting solve.

Reimplemented from oomph::TimeStepper.

Definition at line 144 of file implicit_midpoint_rule.cc.

References oomph::Problem::dof(), oomph::Time::dt(), oomph::Problem::get_dofs(), i, oomph::Problem::ndof(), oomph::Problem::ntime_stepper(), oomph::IMRBase::set_weights(), oomph::Global_string_for_annotation::string(), oomph::Time::time(), oomph::TimeStepper::time_pt(), and oomph::Problem::use_predictor_values_as_initial_guess().

◆ nprev_values_for_value_at_evaluation_time()

unsigned oomph::IMRByBDF::nprev_values_for_value_at_evaluation_time ( ) const

inlinevirtual

Number of history values to interpolate over to get the "current" value. Evaluation time is the end of the bdf1 "half-step", so only need one value as normal.

Implements oomph::IMRBase.

Definition at line 238 of file implicit_midpoint_rule.h.

References oomph::TimeStepper::actions_after_timestep(), and oomph::TimeStepper::actions_before_timestep().

◆ operator=()

void oomph::IMRByBDF::operator= ( const IMRByBDF & dummy )

inlineprivate

Inaccessible assignment operator.

Definition at line 256 of file implicit_midpoint_rule.h.

◆ set_weights()

void oomph::IMRByBDF::set_weights ( )

inlinevirtual

Setup weights for time derivative calculations.

Implements oomph::IMRBase.

Definition at line 227 of file implicit_midpoint_rule.h.

References oomph::Time::dt(), oomph::TimeStepper::Time_pt, and oomph::TimeStepper::Weight.

Member Data Documentation

◆ Update_pinned

bool oomph::IMRByBDF::Update_pinned

Should we update pinned variables after the half-step?

Definition at line 248 of file implicit_midpoint_rule.h.

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

Public Member Functions

Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IMRByBDF() [1/2]

◆ ~IMRByBDF()

◆ IMRByBDF() [2/2]

Member Function Documentation

◆ actions_after_timestep()

◆ actions_before_timestep()

◆ nprev_values_for_value_at_evaluation_time()

◆ operator=()

◆ set_weights()

Member Data Documentation

◆ Update_pinned