oomph::ParameterDerivativeHandler Class Reference

#include <assembly_handler.h>

+ Inheritance diagram for oomph::ParameterDerivativeHandler:

Public Member Functions

 ParameterDerivativeHandler (AssemblyHandler *const &assembly_handler_pt, double *const &parameter_pt)
 Store the original assembly handler and parameter. More...
 
unsigned ndof (GeneralisedElement *const &elem_pt)
 
unsigned long eqn_number (GeneralisedElement *const &elem_pt, const unsigned &ieqn_local)
 
void get_residuals (GeneralisedElement *const &elem_pt, Vector< double > &residuals)
 
void get_jacobian (GeneralisedElement *const &elem_pt, Vector< double > &residuals, DenseMatrix< double > &jacobian)
 
- Public Member Functions inherited from oomph::AssemblyHandler
 AssemblyHandler ()
 Empty constructor. More...
 
virtual void dof_vector (GeneralisedElement *const &elem_pt, const unsigned &t, Vector< double > &dof)
 Return vector of dofs at time level t in the element elem_pt. More...
 
virtual void dof_pt_vector (GeneralisedElement *const &elem_pt, Vector< double * > &dof_pt)
 Return vector of pointers to dofs in the element elem_pt. More...
 
virtual doublelocal_problem_dof (Problem *const &problem_pt, const unsigned &t, const unsigned &i)
 
virtual void get_all_vectors_and_matrices (GeneralisedElement *const &elem_pt, Vector< Vector< double >> &vec, Vector< DenseMatrix< double >> &matrix)
 
virtual void get_dresiduals_dparameter (GeneralisedElement *const &elem_pt, double *const &parameter_pt, Vector< double > &dres_dparam)
 
virtual void get_djacobian_dparameter (GeneralisedElement *const &elem_pt, double *const &parameter_pt, Vector< double > &dres_dparam, DenseMatrix< double > &djac_dparam)
 
virtual void get_hessian_vector_products (GeneralisedElement *const &elem_pt, Vector< double > const &Y, DenseMatrix< double > const &C, DenseMatrix< double > &product)
 
virtual int bifurcation_type () const
 
virtual doublebifurcation_parameter_pt () const
 
virtual void get_eigenfunction (Vector< DoubleVector > &eigenfunction)
 
virtual void get_inner_products (GeneralisedElement *const &elem_pt, Vector< std::pair< unsigned, unsigned >> const &history_index, Vector< double > &inner_product)
 
virtual void get_inner_product_vectors (GeneralisedElement *const &elem_pt, Vector< unsigned > const &history_index, Vector< Vector< double >> &inner_product_vector)
 
virtual ~AssemblyHandler ()
 Empty virtual destructor. More...
 

Private Attributes

doubleParameter_pt
 The value of the parameter. More...
 
AssemblyHandlerAssembly_handler_pt
 The original assembly handler. More...
 

Detailed Description

A class that is used to define the functions used when assembling the derivatives of the residuals with respect to a parameter. The idea is to replace get_residuals with get_dresiduals_dparameter with a particular parameter and assembly handler that are passed on assembly.

Constructor & Destructor Documentation

◆ ParameterDerivativeHandler()

oomph::ParameterDerivativeHandler::ParameterDerivativeHandler ( AssemblyHandler *const &  assembly_handler_pt,
double *const &  parameter_pt 
)
inline

Store the original assembly handler and parameter.

350  : Parameter_pt(parameter_pt), Assembly_handler_pt(assembly_handler_pt)
351  {
352  }
double * Parameter_pt
The value of the parameter.
Definition: assembly_handler.h:341
AssemblyHandler * Assembly_handler_pt
The original assembly handler.
Definition: assembly_handler.h:344

Member Function Documentation

◆ eqn_number()

unsigned long oomph::ParameterDerivativeHandler::eqn_number ( GeneralisedElement *const &  elem_pt,
const unsigned ieqn_local 
)
inlinevirtual

Return the global equation number of the local unknown ieqn_local in elem_pt.Pass through to the original assembly handler

Reimplemented from oomph::AssemblyHandler.

365  {
366  return Assembly_handler_pt->eqn_number(elem_pt, ieqn_local);
367  }
virtual unsigned long eqn_number(GeneralisedElement *const &elem_pt, const unsigned &ieqn_local)
Definition: assembly_handler.cc:82

References Assembly_handler_pt, and oomph::AssemblyHandler::eqn_number().

◆ get_jacobian()

void oomph::ParameterDerivativeHandler::get_jacobian ( GeneralisedElement *const &  elem_pt,
Vector< double > &  residuals,
DenseMatrix< double > &  jacobian 
)
inlinevirtual

Calculate the elemental Jacobian matrix "d equation / d variable" for elem_pt. Overloaded to return the derivatives wrt the parameter

Reimplemented from oomph::AssemblyHandler.

385  {
387  elem_pt, Parameter_pt, residuals, jacobian);
388  }
virtual void get_djacobian_dparameter(GeneralisedElement *const &elem_pt, double *const &parameter_pt, Vector< double > &dres_dparam, DenseMatrix< double > &djac_dparam)
Definition: assembly_handler.cc:138

References Assembly_handler_pt, oomph::AssemblyHandler::get_djacobian_dparameter(), and Parameter_pt.

◆ get_residuals()

void oomph::ParameterDerivativeHandler::get_residuals ( GeneralisedElement *const &  elem_pt,
Vector< double > &  residuals 
)
inlinevirtual

Return the contribution to the residuals of the element elem_pt by using the derivatives

Reimplemented from oomph::AssemblyHandler.

373  {
375  elem_pt, Parameter_pt, residuals);
376  }
virtual void get_dresiduals_dparameter(GeneralisedElement *const &elem_pt, double *const &parameter_pt, Vector< double > &dres_dparam)
Definition: assembly_handler.cc:125

References Assembly_handler_pt, oomph::AssemblyHandler::get_dresiduals_dparameter(), and Parameter_pt.

◆ ndof()

unsigned oomph::ParameterDerivativeHandler::ndof ( GeneralisedElement *const &  elem_pt)
inlinevirtual

Return the number of degrees of freedom in the element elem_pt Pass through to the original assembly handler

Reimplemented from oomph::AssemblyHandler.

357  {
358  return Assembly_handler_pt->ndof(elem_pt);
359  }
virtual unsigned ndof(GeneralisedElement *const &elem_pt)
Return the number of degrees of freedom in the element elem_pt.
Definition: assembly_handler.cc:42

References Assembly_handler_pt, and oomph::AssemblyHandler::ndof().

Member Data Documentation

◆ Assembly_handler_pt

AssemblyHandler* oomph::ParameterDerivativeHandler::Assembly_handler_pt
private

The original assembly handler.

Referenced by eqn_number(), get_jacobian(), get_residuals(), and ndof().

◆ Parameter_pt

double* oomph::ParameterDerivativeHandler::Parameter_pt
private

The value of the parameter.

Referenced by get_jacobian(), and get_residuals().


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