#include <ode_element_for_imr.h>

Inheritance diagram for oomph::IMRODEElement:

Public Member Functions
	IMRODEElement (TimeStepper time_stepper_pt, SolutionFunctorBase exact_solution_pt)
	Constructor. More...

virtual	~IMRODEElement ()
	Virtual destructor. More...

Vector< double >	time_interpolate_u () const

double	time_interpolate_time () const

void	fill_in_contribution_to_residuals (Vector< double > &residuals)

void	fill_in_contribution_to_jacobian (Vector< double > &residuals, DenseMatrix< double > &jacobian)

Public Member Functions inherited from oomph::ODEElement
	ODEElement ()
	Default constructor: null any pointers. More...

	ODEElement (TimeStepper time_stepper_pt, SolutionFunctorBase exact_solution_pt)

void	build (TimeStepper time_stepper_pt, SolutionFunctorBase exact_solution_pt)
	Store pointers, create internal data. More...

virtual	~ODEElement ()

unsigned	nvalue () const

virtual void	fill_in_contribution_to_mass_matrix (Vector< double > &residuals, DenseMatrix< double > &mm)

Vector< double >	exact_solution (const double &t) const
	Exact solution. More...

Vector< double >	derivative_function (const double &t, const Vector< double > &u)
	Exact solution. More...

Public Member Functions inherited from oomph::GeneralisedElement
	GeneralisedElement ()
	Constructor: Initialise all pointers and all values to zero. More...

virtual	~GeneralisedElement ()
	Virtual destructor to clean up any memory allocated by the object. More...

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

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

Data *&	internal_data_pt (const unsigned &i)
	Return a pointer to i-th internal data object. More...

Data *const &	internal_data_pt (const unsigned &i) const
	Return a pointer to i-th internal data object (const version) More...

Data *&	external_data_pt (const unsigned &i)
	Return a pointer to i-th external data object. More...

Data *const &	external_data_pt (const unsigned &i) const
	Return a pointer to i-th external data object (const version) More...

unsigned long	eqn_number (const unsigned &ieqn_local) const

int	local_eqn_number (const unsigned long &ieqn_global) const

unsigned	add_external_data (Data *const &data_pt, const bool &fd=true)

bool	external_data_fd (const unsigned &i) const

void	exclude_external_data_fd (const unsigned &i)

void	include_external_data_fd (const unsigned &i)

void	flush_external_data ()
	Flush all external data. More...

void	flush_external_data (Data *const &data_pt)
	Flush the object addressed by data_pt from the external data array. More...

unsigned	ninternal_data () const
	Return the number of internal data objects. More...

unsigned	nexternal_data () const
	Return the number of external data objects. More...

unsigned	ndof () const
	Return the number of equations/dofs in the element. More...

void	dof_vector (const unsigned &t, Vector< double > &dof)
	Return the vector of dof values at time level t. More...

void	dof_pt_vector (Vector< double * > &dof_pt)
	Return the vector of pointers to dof values. More...

void	set_internal_data_time_stepper (const unsigned &i, TimeStepper *const &time_stepper_pt, const bool &preserve_existing_data)

void	assign_internal_eqn_numbers (unsigned long &global_number, Vector< double * > &Dof_pt)

void	describe_dofs (std::ostream &out, const std::string &current_string) const

virtual void	describe_local_dofs (std::ostream &out, const std::string &current_string) const

void	add_internal_value_pt_to_map (std::map< unsigned, double * > &map_of_value_pt)

virtual void	assign_local_eqn_numbers (const bool &store_local_dof_pt)

virtual void	complete_setup_of_dependencies ()

virtual void	get_residuals (Vector< double > &residuals)

virtual void	get_jacobian (Vector< double > &residuals, DenseMatrix< double > &jacobian)

virtual void	get_mass_matrix (Vector< double > &residuals, DenseMatrix< double > &mass_matrix)

virtual void	get_jacobian_and_mass_matrix (Vector< double > &residuals, DenseMatrix< double > &jacobian, DenseMatrix< double > &mass_matrix)

virtual void	get_dresiduals_dparameter (double *const &parameter_pt, Vector< double > &dres_dparam)

virtual void	get_djacobian_dparameter (double *const &parameter_pt, Vector< double > &dres_dparam, DenseMatrix< double > &djac_dparam)

virtual void	get_djacobian_and_dmass_matrix_dparameter (double *const &parameter_pt, Vector< double > &dres_dparam, DenseMatrix< double > &djac_dparam, DenseMatrix< double > &dmass_matrix_dparam)

virtual void	get_hessian_vector_products (Vector< double > const &Y, DenseMatrix< double > const &C, DenseMatrix< double > &product)

virtual void	get_inner_products (Vector< std::pair< unsigned, unsigned >> const &history_index, Vector< double > &inner_product)

virtual void	get_inner_product_vectors (Vector< unsigned > const &history_index, Vector< Vector< double >> &inner_product_vector)

virtual unsigned	self_test ()

virtual void	compute_norm (Vector< double > &norm)

virtual void	compute_norm (double &norm)

virtual unsigned	ndof_types () const

virtual void	get_dof_numbers_for_unknowns (std::list< std::pair< unsigned long, unsigned >> &dof_lookup_list) const

Private Member Functions
	IMRODEElement (const IMRODEElement &dummy)
	Broken copy constructor. More...

Additional Inherited Members
Public Attributes inherited from oomph::ODEElement
SolutionFunctorBase *	Exact_solution_pt

bool	Use_fd_jacobian

Static Public Attributes inherited from oomph::GeneralisedElement
static bool	Suppress_warning_about_repeated_internal_data

static bool	Suppress_warning_about_repeated_external_data = true

static double	Default_fd_jacobian_step = 1.0e-8

Protected Member Functions inherited from oomph::GeneralisedElement
unsigned	add_internal_data (Data *const &data_pt, const bool &fd=true)

bool	internal_data_fd (const unsigned &i) const

void	exclude_internal_data_fd (const unsigned &i)

void	include_internal_data_fd (const unsigned &i)

void	clear_global_eqn_numbers ()

void	add_global_eqn_numbers (std::deque< unsigned long > const &global_eqn_numbers, std::deque< double * > const &global_dof_pt)

virtual void	assign_internal_and_external_local_eqn_numbers (const bool &store_local_dof_pt)

virtual void	assign_all_generic_local_eqn_numbers (const bool &store_local_dof_pt)

virtual void	assign_additional_local_eqn_numbers ()

int	internal_local_eqn (const unsigned &i, const unsigned &j) const

int	external_local_eqn (const unsigned &i, const unsigned &j)

void	fill_in_jacobian_from_internal_by_fd (Vector< double > &residuals, DenseMatrix< double > &jacobian, const bool &fd_all_data=false)

void	fill_in_jacobian_from_internal_by_fd (DenseMatrix< double > &jacobian, const bool &fd_all_data=false)

void	fill_in_jacobian_from_external_by_fd (Vector< double > &residuals, DenseMatrix< double > &jacobian, const bool &fd_all_data=false)

void	fill_in_jacobian_from_external_by_fd (DenseMatrix< double > &jacobian, const bool &fd_all_data=false)

virtual void	update_before_internal_fd ()

virtual void	reset_after_internal_fd ()

virtual void	update_in_internal_fd (const unsigned &i)

virtual void	reset_in_internal_fd (const unsigned &i)

virtual void	update_before_external_fd ()

virtual void	reset_after_external_fd ()

virtual void	update_in_external_fd (const unsigned &i)

virtual void	reset_in_external_fd (const unsigned &i)

virtual void	fill_in_contribution_to_jacobian_and_mass_matrix (Vector< double > &residuals, DenseMatrix< double > &jacobian, DenseMatrix< double > &mass_matrix)

virtual void	fill_in_contribution_to_dresiduals_dparameter (double *const &parameter_pt, Vector< double > &dres_dparam)

virtual void	fill_in_contribution_to_djacobian_dparameter (double *const &parameter_pt, Vector< double > &dres_dparam, DenseMatrix< double > &djac_dparam)

virtual void	fill_in_contribution_to_djacobian_and_dmass_matrix_dparameter (double *const &parameter_pt, Vector< double > &dres_dparam, DenseMatrix< double > &djac_dparam, DenseMatrix< double > &dmass_matrix_dparam)

virtual void	fill_in_contribution_to_hessian_vector_products (Vector< double > const &Y, DenseMatrix< double > const &C, DenseMatrix< double > &product)

virtual void	fill_in_contribution_to_inner_products (Vector< std::pair< unsigned, unsigned >> const &history_index, Vector< double > &inner_product)

virtual void	fill_in_contribution_to_inner_product_vectors (Vector< unsigned > const &history_index, Vector< Vector< double >> &inner_product_vector)

Static Protected Attributes inherited from oomph::GeneralisedElement
static DenseMatrix< double >	Dummy_matrix

static std::deque< double * >	Dof_pt_deque

Detailed Description

Class for ODE elements when using the implicit midpoint rule time integrator IMR. The residual and Jacobian functions are modified to interpolate in time. Note that the normal element can be used for the IMR implementation in the class IMRByBDF.

Constructor & Destructor Documentation

◆ IMRODEElement() [1/2]

oomph::IMRODEElement::IMRODEElement	(	TimeStepper *	time_stepper_pt,
		SolutionFunctorBase *	exact_solution_pt
	)

inline

Constructor.

45 : ODEElement(time_stepper_pt, exact_solution_pt) {}

oomph::ODEElement::ODEElement

ODEElement()

Default constructor: null any pointers.

Definition: ode_elements.h:44

◆ ~IMRODEElement()

virtual oomph::IMRODEElement::~IMRODEElement ( )

inlinevirtual

Virtual destructor.

48 {}

◆ IMRODEElement() [2/2]

oomph::IMRODEElement::IMRODEElement ( const IMRODEElement & dummy )

inlineprivate

Broken copy constructor.

193 {BrokenCopy::broken_copy("IMRODEElement");}

oomph::BrokenCopy::broken_copy

void broken_copy(const std::string &class_name)

Issue error message and terminate execution.

Definition: oomph_utilities.cc:212

References oomph::BrokenCopy::broken_copy().

Member Function Documentation

◆ fill_in_contribution_to_jacobian()

void oomph::IMRODEElement::fill_in_contribution_to_jacobian	(	Vector< double > &	residuals,
		DenseMatrix< double > &	jacobian
	)

inlinevirtual

Modified get jacobian: two differences from the normal verson here which are required when using the IMR implementation: 1) We have to interpolate in time to calculate the analytical contribution. 2) The interpolation in time within the residual calculation modifies the Jacobian (because the jacobian is the derivative w.r.t. the n+1-th values).

Reimplemented from oomph::ODEElement.

   {
    // Get residuals
    fill_in_contribution_to_residuals(residuals);
  
    if(Exact_solution_pt->have_jacobian() && !Use_fd_jacobian)
     {
      const unsigned n = nvalue();
      TimeStepper* ts_pt = internal_data_pt(0)->time_stepper_pt();
  
      // Get values **interpolated in time**
      Vector<double> u = time_interpolate_u();
  
      // Get **interpolated** continuous time
      double t = time_interpolate_time();
  
      // get df/du jacobian analytically
      Vector<double> dummy;
      Exact_solution_pt->jacobian(t, dummy, u, jacobian);
  
      // Multiply by the weight of the history value 0 (i.e. at time n+1) in
      // the calculation of the time-interpolated "current" value (0th
      // derivative). Need to do this because of the chain rule, just write
      // out the derivation of dr/du for nvalue=1 to see it.
      const double w00 = ts_pt->weight(0,0);
      for(unsigned i=0; i<n; i++)
       {
        for(unsigned j=0; j<n; j++)
         {
          jacobian(i, j) *= w00;
         }
       }
  
      // We actually need jacobian of residual = f(imr_t, imr_u) - dudt so
      // subtract diagonal (dudt)/du term now.
      const double w10 = ts_pt->weight(1,0);
      for(unsigned i=0; i<n; i++)
       {
        jacobian(i, i) -= w10;
       }
     }
    else
     {
      // Use FD for jacobian
      GeneralisedElement::fill_in_jacobian_from_internal_by_fd
       (residuals, jacobian, true);
     }
    }

References oomph::ODEElement::Exact_solution_pt, fill_in_contribution_to_residuals(), oomph::GeneralisedElement::fill_in_jacobian_from_internal_by_fd(), oomph::SolutionFunctorBase::have_jacobian(), i, oomph::GeneralisedElement::internal_data_pt(), j, oomph::SolutionFunctorBase::jacobian(), n, oomph::ODEElement::nvalue(), plotPSD::t, time_interpolate_time(), time_interpolate_u(), oomph::Data::time_stepper_pt(), oomph::ODEElement::Use_fd_jacobian, and oomph::TimeStepper::weight().

◆ fill_in_contribution_to_residuals()

void oomph::IMRODEElement::fill_in_contribution_to_residuals ( Vector< double > & residuals )

inlinevirtual

Modified get residuals: have to interpolate in time for IMR when using the IMR implementation so we can't use the normal ODE element implementation.

Reimplemented from oomph::ODEElement.

    {
  
     // Get pointer to one-and-only internal data object
     Data* dat_pt = internal_data_pt(0);
  
     // Get time stepper
     TimeStepper* ts_pt = dat_pt->time_stepper_pt();
  
     // Get values **interpolated in time**
     Vector<double> u = time_interpolate_u();
  
     // Get **interpolated** continuous time
     double t = time_interpolate_time();
  
     Vector<double> deriv = derivative_function(t, u);
     for(unsigned j=0, nj=deriv.size(); j<nj; j++)
      {
       // Get dudt approximation from time stepper
       double dudt = ts_pt->time_derivative(1, dat_pt, j);
  
       // Residual is difference between the exact derivative and our
       // time stepper's derivative estimate.
       residuals[j] = deriv[j] - dudt;
      }
    }

References oomph::ODEElement::derivative_function(), oomph::GeneralisedElement::internal_data_pt(), j, plotPSD::t, oomph::TimeStepper::time_derivative(), time_interpolate_time(), time_interpolate_u(), and oomph::Data::time_stepper_pt().

Referenced by fill_in_contribution_to_jacobian().

◆ time_interpolate_time()

double oomph::IMRODEElement::time_interpolate_time ( ) const

inline

For IMR implemented using IMR we have to interpolate everything in time (to get the midpoint values). This function does that for the continuous time.

   {
  
    // Get pointer to one-and-only internal data object
    Data* dat_pt = internal_data_pt(0);
  
    // Get time stepper
    TimeStepper* ts_pt = dat_pt->time_stepper_pt();
  
    // Number of history values to interpolate over for value/time calculation
    const unsigned nj = ts_pt->nprev_values_for_value_at_evaluation_time();
  
    double t = 0;
    for(unsigned j=0; j<nj; j++)
     {
      t += ts_pt->time_pt()->time(j) * ts_pt->weight(0, j);
     }
  
    return t;
   }

References oomph::GeneralisedElement::internal_data_pt(), j, oomph::TimeStepper::nprev_values_for_value_at_evaluation_time(), plotPSD::t, oomph::Time::time(), oomph::TimeStepper::time_pt(), oomph::Data::time_stepper_pt(), and oomph::TimeStepper::weight().

Referenced by fill_in_contribution_to_jacobian(), and fill_in_contribution_to_residuals().

◆ time_interpolate_u()

Vector<double> oomph::IMRODEElement::time_interpolate_u ( ) const

inline

For IMR implemented using IMR we have to interpolate everything in time (to get the midpoint values). This function does that for the u values.

   {
  
    // Get pointer to one-and-only internal data object
    Data* dat_pt = internal_data_pt(0);
  
    // Get time stepper
    TimeStepper* ts_pt = dat_pt->time_stepper_pt();
    
    // Number of history values to interpolate over for value/time calculation
    const unsigned nj = ts_pt->nprev_values_for_value_at_evaluation_time();
  
    Vector<double> u(nvalue(), 0.0);
    for(unsigned j=0; j<nj; j++)
     {
      for(unsigned i=0; i<nvalue(); i++)
       {
        u[i] += dat_pt->value(j, i) * ts_pt->weight(0, j);
       }
     }
  
    return u;   
   }

References i, oomph::GeneralisedElement::internal_data_pt(), j, oomph::TimeStepper::nprev_values_for_value_at_evaluation_time(), oomph::ODEElement::nvalue(), oomph::Data::time_stepper_pt(), oomph::Data::value(), and oomph::TimeStepper::weight().

Referenced by fill_in_contribution_to_jacobian(), and fill_in_contribution_to_residuals().

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

ode_element_for_imr.h

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IMRODEElement() [1/2]

◆ ~IMRODEElement()

◆ IMRODEElement() [2/2]

Member Function Documentation

◆ fill_in_contribution_to_jacobian()

◆ fill_in_contribution_to_residuals()

◆ time_interpolate_time()

◆ time_interpolate_u()