oomph::BlockPreconditionableSpaceTimeElementBase Class Reference

#include <general_purpose_space_time_block_preconditionable_elements.h>

Inheritance diagram for oomph::BlockPreconditionableSpaceTimeElementBase:

Public Member Functions
	BlockPreconditionableSpaceTimeElementBase ()
	Constructor (empty) More...
	~BlockPreconditionableSpaceTimeElementBase ()
	Destructor (empty) More...
void	set_time_slab_id (const int &time_slice_id)
	Access function to assign the time slice this element lies in. More...
void	set_ndof_types (const unsigned &n_dof_types)
unsigned	ndof_types () const
virtual void	get_dof_numbers_for_unknowns (std::list< std::pair< unsigned long, unsigned >> &dof_lookup_list) const =0
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)

Protected Attributes
unsigned	N_dof_types
	The number of time slices in the mesh. More...
int	Time_slab_id
	The time slice this element lies within. More...

Additional Inherited Members
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)
virtual void	fill_in_contribution_to_residuals (Vector< double > &residuals)
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 (Vector< double > &residuals, DenseMatrix< double > &jacobian)
virtual void	fill_in_contribution_to_mass_matrix (Vector< double > &residuals, DenseMatrix< double > &mass_matrix)
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

Block preconditionable space-time element base class. NOTE: It has to derive from GeneralisedElement so that it can overload the implementation of ndof_types() in GeneralisedElement.

Constructor & Destructor Documentation

BlockPreconditionableSpaceTimeElementBase()

oomph::BlockPreconditionableSpaceTimeElementBase::BlockPreconditionableSpaceTimeElementBase ( )

inline

Constructor (empty)

{}

~BlockPreconditionableSpaceTimeElementBase()

oomph::BlockPreconditionableSpaceTimeElementBase::~BlockPreconditionableSpaceTimeElementBase ( )

inline

Destructor (empty)

{}

Member Function Documentation

get_dof_numbers_for_unknowns()

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

pure virtual

Pure virtual function to be implemented in a derived class. Create a list of pairs for all unknowns in this element, so the first entry in each pair contains the global equation number of the unknown, while the second one contains the number of the "DOF type" that this unknown is associated with.

Reimplemented from oomph::GeneralisedElement.

Implemented in oomph::BlockPrecRefineableQUnsteadyHeatMixedOrderSpaceTimeElement< SPATIAL_DIM, NNODE_1D >, oomph::BlockPrecQUnsteadyHeatMixedOrderSpaceTimeElement< SPATIAL_DIM, NNODE_1D >, oomph::BlockPrecRefineableQUnsteadyHeatSpaceTimeElement< SPATIAL_DIM, NNODE_1D >, oomph::BlockPrecQUnsteadyHeatSpaceTimeElement< SPATIAL_DIM, NNODE_1D >, oomph::BlockPrecRefineableQUnsteadyHeatSpaceTimeElement< SPATIAL_DIM, NNODE_1D >, oomph::BlockPrecQUnsteadyHeatSpaceTimeElement< SPATIAL_DIM, NNODE_1D >, oomph::BlockPrecQTaylorHoodMixedOrderSpaceTimeElement, and oomph::BlockPrecQTaylorHoodSpaceTimeElement.

ndof_types()

unsigned oomph::BlockPreconditionableSpaceTimeElementBase::ndof_types ( ) const

inlinevirtual

Return the number of "DOF types" that the degrees of freedom in this element are sub-divided into

Reimplemented from oomph::GeneralisedElement.

    {
      // Return the number of dof types being used in the mesh
      return this->N_dof_types;
    } // End of ndof_types

References N_dof_types.

set_ndof_types()

void oomph::BlockPreconditionableSpaceTimeElementBase::set_ndof_types ( const unsigned &  n_dof_types )

inline

Access function to assign the number of dof types in the mesh NOTE: We have an access function for this as N_dof_types relies on the number of time slices in the mesh which isn't something one individual element should know...

    {
      // Return the value that is currently stored
      N_dof_types = n_dof_types;
    } // End of set_ndof_types

References N_dof_types.

set_time_slab_id()

void oomph::BlockPreconditionableSpaceTimeElementBase::set_time_slab_id ( const int &  time_slice_id )

inline

Access function to assign the time slice this element lies in.

    {
      // The time slice must be greater than -1. This happens when we use
      // an impulsive start so there are no dofs in the first time slice
      // of the first elemental time slice of the first but there are proper
      // dofs in the final time slice of the first elemental time slice.
      if (time_slice_id < -1)
      {
        // Throw an error
        throw OomphLibError(
          "Time slice ID must be greater than or equal to -1!",
          OOMPH_CURRENT_FUNCTION,
          OOMPH_EXCEPTION_LOCATION);
      }
 
      // Return the value that is currently stored
      Time_slab_id = time_slice_id;
    } // End of set_time_slab_id

References OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION, and Time_slab_id.

Member Data Documentation

N_dof_types

unsigned oomph::BlockPreconditionableSpaceTimeElementBase::N_dof_types

protected

The number of time slices in the mesh.

Referenced by ndof_types(), and set_ndof_types().

Time_slab_id

int oomph::BlockPreconditionableSpaceTimeElementBase::Time_slab_id

protected

The time slice this element lies within.

Referenced by oomph::BlockPrecQTaylorHoodSpaceTimeElement::get_dof_numbers_for_unknowns(), oomph::BlockPrecQTaylorHoodMixedOrderSpaceTimeElement::get_dof_numbers_for_unknowns(), and set_time_slab_id().

---

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

• general_purpose_space_time_block_preconditionable_elements.h