#include <generalised_timesteppers.h>

Inheritance diagram for oomph::GeneralisedTimeStepper:

Public Member Functions
unsigned	ndof_storage_entries () const
	Return the number of entries that correspond to dof storage. More...

Public Member Functions inherited from oomph::TimeStepper
	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 Member Functions
	GeneralisedTimeStepper (const unsigned &n_tstorage, const unsigned &max_deriv, const unsigned &ndof_storage_entries=1)

	GeneralisedTimeStepper ()
	Broken empty constructor. More...

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

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

Protected Attributes
unsigned	Ndof_storage_entries

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

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

Generalised timestepper that can serve a variety of purposes in continuation, bifurcation detection and periodic-orbit computations. The key generalisation is that more than one of the entries is actually a degree of freedom in the problem. These are distinct from our standard (implict) Timesteppers in which the only dof is the current value (first entry in the storage scheme). These objects will typically be used to replace exisiting timesteppers for specific tasks.

Constructor & Destructor Documentation

◆ GeneralisedTimeStepper() [1/3]

oomph::GeneralisedTimeStepper::GeneralisedTimeStepper	(	const unsigned &	n_tstorage,
		const unsigned &	max_deriv,
		const unsigned &	ndof_storage_entries = `1`
	)

inlineprotected

Constructor that can only be called by derived objects. Pass the information directly through to the TimeStepper object

       : TimeStepper(n_tstorage, max_deriv),
         Ndof_storage_entries(ndof_storage_entries)
     {
       // Dof_storage_index.resize(1,0.0);
     }

◆ GeneralisedTimeStepper() [2/3]

oomph::GeneralisedTimeStepper::GeneralisedTimeStepper ( )

inlineprotected

Broken empty constructor.

71 : TimeStepper() {}

◆ GeneralisedTimeStepper() [3/3]

oomph::GeneralisedTimeStepper::GeneralisedTimeStepper ( const GeneralisedTimeStepper & )

protecteddelete

Broken copy constructor.

Member Function Documentation

◆ ndof_storage_entries()

unsigned oomph::GeneralisedTimeStepper::ndof_storage_entries ( ) const

inline

Return the number of entries that correspond to dof storage.

     {
       return Ndof_storage_entries;
     }

References Ndof_storage_entries.

Referenced by oomph::ContinuationStorageScheme::modify_storage().

◆ operator=()

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

protecteddelete

Broken assignment operator.

Member Data Documentation

◆ Ndof_storage_entries

unsigned oomph::GeneralisedTimeStepper::Ndof_storage_entries

protected

Referenced by oomph::ContinuationStorageScheme::modify_storage(), ndof_storage_entries(), oomph::ContinuationStorageScheme::set_consistent_pinned_positions(), and oomph::ContinuationStorageScheme::set_consistent_pinned_values().

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

generalised_timesteppers.h

Public Member Functions

Protected Member Functions

Protected Attributes