#include <timesteppers.h>

Inheritance diagram for oomph::Steady< NSTEPS >:

Public Types
typedef double(*	InitialConditionFctPt) (const double &t)
	Typedef for function that returns the (scalar) initial value at a given value of the continuous time t. More...

Public Member Functions
	Steady ()
	Constructor: Creates storage for NSTEPS previous timesteps and can evaluate up to 2nd derivatives (though it doesn't actually do anything – all time-derivatives evaluate to zero) More...

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

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

unsigned	order () const
	Return the actual order of the scheme. Returning zero here – doesn't make much sense, though. More...

void	assign_initial_values_impulsive (Data *const &data_pt)
	Initialise the time-history for the Data values, corresponding to an impulsive start. More...

void	assign_initial_positions_impulsive (Node *const &node_pt)
	Initialise the time-history for the nodal positions corresponding to an impulsive start. More...

void	assign_initial_data_values (Data *const &data_pt, Vector< InitialConditionFctPt > initial_value_fct)
	Initialise the time-history for the Data values, corresponding to given time history, specified by Vector of function pointers. More...

void	shift_time_values (Data *const &data_pt)
	This function updates the Data's time history so that we can advance to the next timestep. As for BDF schemes, we simply push the values backwards... More...

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

void	set_weights ()
	Set weights. More...

unsigned	nprev_values () const
	Number of previous values available. More...

unsigned	ndt () const
	Number of timestep increments that need to be stored by the scheme. More...

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

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

virtual unsigned	nprev_values_for_value_at_evaluation_time () const
	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. 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 ()

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

virtual void	set_predictor_weights ()
	Set the weights for the predictor previous timestep (currently empty – overwrite for specific scheme) More...

virtual void	calculate_predicted_values (Data *const &data_pt)
	Do the predictor step for data stored in a Data object (currently empty – overwrite for specific scheme) More...

virtual 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...

virtual void	set_error_weights ()
	Set the weights for the error computation, (currently empty – overwrite for specific scheme) More...

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)

Static Private Attributes
static double	One =1.0
	Static variable to hold the value 1.0. More...

static double	Zero =0.0
	Static variable to hold the value 0.0. More...

static Time	Dummy_time

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

template<unsigned NSTEPS>
class oomph::Steady< NSTEPS >

Faux time-stepper for steady problems. Allows storage for NSTEPS previous values.

Definition at line 633 of file timesteppers.h.

Member Typedef Documentation

◆ InitialConditionFctPt

template<unsigned NSTEPS>

typedef double(* oomph::Steady< NSTEPS >::InitialConditionFctPt) (const double &t)

Typedef for function that returns the (scalar) initial value at a given value of the continuous time t.

Definition at line 718 of file timesteppers.h.

Constructor & Destructor Documentation

◆ Steady() [1/2]

template<unsigned NSTEPS>

oomph::Steady< NSTEPS >::Steady ( )

inline

Constructor: Creates storage for NSTEPS previous timesteps and can evaluate up to 2nd derivatives (though it doesn't actually do anything – all time-derivatives evaluate to zero)

Definition at line 642 of file timesteppers.h.

◆ Steady() [2/2]

template<unsigned NSTEPS>

oomph::Steady< NSTEPS >::Steady ( const Steady< NSTEPS > & )

inline

Broken copy constructor.

Definition at line 654 of file timesteppers.h.

Member Function Documentation

◆ assign_initial_data_values()

template<unsigned NSTEPS>

void oomph::Steady< NSTEPS >::assign_initial_data_values	(	Data *const &	data_pt,
		Vector< InitialConditionFctPt >	initial_value_fct
	)

inline

Initialise the time-history for the Data values, corresponding to given time history, specified by Vector of function pointers.

Definition at line 723 of file timesteppers.h.

◆ assign_initial_positions_impulsive()

template<unsigned NSTEPS>

void oomph::Steady< NSTEPS >::assign_initial_positions_impulsive ( Node *const & node_pt )

inlinevirtual

Initialise the time-history for the nodal positions corresponding to an impulsive start.

Implements oomph::TimeStepper.

Definition at line 691 of file timesteppers.h.

◆ assign_initial_values_impulsive()

template<unsigned NSTEPS>

void oomph::Steady< NSTEPS >::assign_initial_values_impulsive ( Data *const & data_pt )

inlinevirtual

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

Implements oomph::TimeStepper.

Definition at line 671 of file timesteppers.h.

◆ ndt()

template<unsigned NSTEPS>

unsigned oomph::Steady< NSTEPS >::ndt ( ) const

inlinevirtual

Number of timestep increments that need to be stored by the scheme.

Implements oomph::TimeStepper.

Definition at line 818 of file timesteppers.h.

◆ nprev_values()

template<unsigned NSTEPS>

unsigned oomph::Steady< NSTEPS >::nprev_values ( ) const

inlinevirtual

Number of previous values available.

Implements oomph::TimeStepper.

Definition at line 815 of file timesteppers.h.

◆ operator=()

template<unsigned NSTEPS>

void oomph::Steady< NSTEPS >::operator= ( const Steady< NSTEPS > & )

inline

Broken assignment operator.

Definition at line 660 of file timesteppers.h.

◆ order()

template<unsigned NSTEPS>

unsigned oomph::Steady< NSTEPS >::order ( ) const

inlinevirtual

Return the actual order of the scheme. Returning zero here – doesn't make much sense, though.

Reimplemented from oomph::TimeStepper.

Definition at line 667 of file timesteppers.h.

◆ set_weights()

template<unsigned NSTEPS>

void oomph::Steady< NSTEPS >::set_weights ( )

inlinevirtual

Set weights.

Implements oomph::TimeStepper.

Definition at line 798 of file timesteppers.h.

◆ shift_time_positions()

template<unsigned NSTEPS>

void oomph::Steady< NSTEPS >::shift_time_positions ( Node *const & node_pt )

inlinevirtual

This function advances the time history of the positions at a node.

Implements oomph::TimeStepper.

Definition at line 772 of file timesteppers.h.

◆ shift_time_values()

template<unsigned NSTEPS>

void oomph::Steady< NSTEPS >::shift_time_values ( Data *const & data_pt )

inlinevirtual

This function updates the Data's time history so that we can advance to the next timestep. As for BDF schemes, we simply push the values backwards...

Implements oomph::TimeStepper.

Definition at line 750 of file timesteppers.h.

◆ weight()

template<unsigned NSTEPS>

double oomph::Steady< NSTEPS >::weight	(	const unsigned &	i,
		const unsigned &	j
	)		const

inlinevirtual

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

Reimplemented from oomph::TimeStepper.

Definition at line 821 of file timesteppers.h.

Member Data Documentation

◆ Dummy_time

template<unsigned NSTEPS>

Time oomph::Steady< NSTEPS >::Dummy_time

staticprivate

Definition at line 842 of file timesteppers.h.

Referenced by oomph::TimeStepper::~TimeStepper().

◆ One

template<unsigned NSTEPS>

double oomph::Steady< NSTEPS >::One =1.0

staticprivate

Static variable to hold the value 1.0.

Definition at line 836 of file timesteppers.h.

◆ Zero

template<unsigned NSTEPS>

double oomph::Steady< NSTEPS >::Zero =0.0

staticprivate

Static variable to hold the value 0.0.

Definition at line 839 of file timesteppers.h.

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

Public Types

Public Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

template<unsigned NSTEPS> class oomph::Steady< NSTEPS >

Member Typedef Documentation

◆ InitialConditionFctPt

Constructor & Destructor Documentation

◆ Steady() [1/2]

◆ Steady() [2/2]

Member Function Documentation

◆ assign_initial_data_values()

◆ assign_initial_positions_impulsive()

◆ assign_initial_values_impulsive()

◆ ndt()

◆ nprev_values()

◆ operator=()

◆ order()

◆ set_weights()

◆ shift_time_positions()

◆ shift_time_values()

◆ weight()

Member Data Documentation

◆ Dummy_time

◆ One

◆ Zero

template<unsigned NSTEPS>
class oomph::Steady< NSTEPS >