Mini Element to implement the eigenvalue constraint. More...

Inheritance diagram for ZeroResidualGenElement:

Public Member Functions
	ZeroResidualGenElement ()
	Simple constructor. More...

virtual	~ZeroResidualGenElement ()
	Destructor. More...

double &	eval ()
	Access function for the the eigenvalue. More...

double *	eval_pt ()

void	fill_in_contribution_to_residuals (Vector< double > &residuals)

void	get_residuals (Vector< double > &residuals)

void	output (std::ostream &output, const unsigned &)

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_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 Attributes
OrrSommerfeldProblem< QOrrSommerfeldElement< 1, 3 > > *	eigenvalue_problem_pt

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)

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

Mini Element to implement the eigenvalue constraint.

///////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////

Constructor & Destructor Documentation

◆ ZeroResidualGenElement()

ZeroResidualGenElement::ZeroResidualGenElement ( )

inline

Simple constructor.

   {
    //One item of internal data will store the real part of the eigenvalue
    add_internal_data(new Data(1));
    
    //Construct the eigenvalue problem
    eigenvalue_problem_pt = new 
     OrrSommerfeldProblem<QOrrSommerfeldElement<1,3> >
     (Param::N_element,internal_data_pt(0)->value_pt(0));
   }

References oomph::GeneralisedElement::add_internal_data(), eigenvalue_problem_pt, oomph::GeneralisedElement::internal_data_pt(), Param::N_element, and oomph::Data::value_pt().

◆ ~ZeroResidualGenElement()

virtual ZeroResidualGenElement::~ZeroResidualGenElement ( )

inlinevirtual

Destructor.

950 {delete eigenvalue_problem_pt;}

References eigenvalue_problem_pt.

Member Function Documentation

◆ eval()

double& ZeroResidualGenElement::eval ( )

inline

Access function for the the eigenvalue.

953 {return *(internal_data_pt(0)->value_pt(0));}

References oomph::GeneralisedElement::internal_data_pt(), and oomph::Data::value_pt().

Referenced by ContinuationProblem::ContinuationProblem(), ContinuationProblem::doc_solution(), fill_in_contribution_to_residuals(), and ContinuationProblem::solve().

◆ eval_pt()

double* ZeroResidualGenElement::eval_pt ( )

inline

955 {return internal_data_pt(0)->value_pt(0);}

References oomph::GeneralisedElement::internal_data_pt(), and oomph::Data::value_pt().

◆ fill_in_contribution_to_residuals()

void ZeroResidualGenElement::fill_in_contribution_to_residuals ( Vector< double > & residuals )

inlinevirtual

Add the elemental contribution to the residuals vector. Note that this function will NOT initialise the residuals vector. It must be called after the residuals vector has been initialised to zero.

Reimplemented from oomph::GeneralisedElement.

   {
    //There is only one value
    unsigned n_dof = ndof();
    //If we're pinned return
    if(n_dof==0) return;
    
    //Solve the eigenvalue problem
    Vector<complex<double> > eval;
    eigenvalue_problem_pt->solve_eigenproblem(4,eval);
    //We need to make sure that we pick the eigenvalue with the largest real 
    //part
    unsigned index=0;
    double e_real = eval[0].real();
  
    //Loop over the eigenvalues and find the smallest magnitude
    for(unsigned i=1;i<eval.size();i++)
     {
      if(eval[i].real() > e_real) {e_real = eval[i].real(); index=i;}
     }
    //Now set the residuals to be the eigenvalue with largest real part
    residuals[0] = eval[index].real();
   }

References eigenvalue_problem_pt, eval(), i, and oomph::GeneralisedElement::ndof().

Referenced by get_residuals().

◆ get_residuals()

void ZeroResidualGenElement::get_residuals ( Vector< double > & residuals )

inlinevirtual

Calculate the vector of residuals of the equations in the element. By default initialise the vector to zero and then call the fill_in_contribution_to_residuals() function. Note that this entire function can be overloaded if desired.

Reimplemented from oomph::GeneralisedElement.

   {
    fill_in_contribution_to_residuals(residuals);
   }

References fill_in_contribution_to_residuals().

◆ output()

void ZeroResidualGenElement::output	(	std::ostream &	output,
		const unsigned &
	)

inline

   {
    eigenvalue_problem_pt->mesh_pt()->output(output,5);
   }

References eigenvalue_problem_pt.

Member Data Documentation

◆ eigenvalue_problem_pt

OrrSommerfeldProblem<QOrrSommerfeldElement<1,3> >* ZeroResidualGenElement::eigenvalue_problem_pt

private

Referenced by fill_in_contribution_to_residuals(), output(), ZeroResidualGenElement(), and ~ZeroResidualGenElement().

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

orr_sommerfeld.cc

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ZeroResidualGenElement()

◆ ~ZeroResidualGenElement()

Member Function Documentation

◆ eval()

◆ eval_pt()

◆ fill_in_contribution_to_residuals()

◆ get_residuals()

◆ output()

Member Data Documentation

◆ eigenvalue_problem_pt