#include <constrained_volume_elements.h>

Inheritance diagram for oomph::VolumeConstraintElement:

Public Member Functions
	VolumeConstraintElement (double *prescribed_volume_pt)

	VolumeConstraintElement (double prescribed_volume_pt, Data p_traded_data_pt, const unsigned &index_of_traded_pressure)

	~VolumeConstraintElement ()
	Empty destructor. More...

Data *	p_traded_data_pt ()
	Access to Data that contains the traded pressure. More...

double	p_traded ()
	Return the traded pressure value. More...

unsigned	index_of_traded_pressure ()
	Return the index of Data object at which the traded pressure is stored. More...

void	fill_in_contribution_to_residuals (Vector< double > &residuals)
	Fill in the residuals for the volume constraint. More...

void	fill_in_contribution_to_jacobian (Vector< double > &residuals, DenseMatrix< double > &jacobian)
	Fill in the residuals and jacobian for the volume constraint. More...

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

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
int	ptraded_local_eqn ()
	The local eqn number for the traded pressure. More...

void	fill_in_generic_contribution_to_residuals_volume_constraint (Vector< double > &residuals)
	Fill in the residuals for the volume constraint. More...

Private Attributes
double *	Prescribed_volume_pt
	Pointer to the desired value of the volume. More...

unsigned	External_or_internal_data_index_of_traded_pressure

bool	Traded_pressure_stored_as_internal_data

unsigned	Index_of_traded_pressure_value

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_mass_matrix (Vector< double > &residuals, 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

A class that is used to implement the constraint that the fluid volume in a region bounded by associated FaceElements (attached, e.g., to the mesh boundaries that enclose a bubble) must take a specific value. This GeneralisedElement is used only to store the desired volume and a pointer to the (usually pressure) freedom that must be traded for the volume constraint.

Constructor & Destructor Documentation

◆ VolumeConstraintElement() [1/2]

oomph::VolumeConstraintElement::VolumeConstraintElement ( double * prescribed_volume_pt )

Constructor: Pass pointer to target volume. "Pressure" value that "traded" for the volume contraint is created internally (as a Data item with a single pressure value)

   {
     // Store pointer to prescribed volume
     Prescribed_volume_pt = prescribed_volume_pt;
  
     // Create data, add as internal data and record the index
     // (gets deleted automatically in destructor of GeneralisedElement)
     External_or_internal_data_index_of_traded_pressure =
       add_internal_data(new Data(1));
  
     // Record that we've created it as internal data
     Traded_pressure_stored_as_internal_data = true;
  
     // ...and stored the "traded pressure" value as first value
     Index_of_traded_pressure_value = 0;
   }

References oomph::GeneralisedElement::add_internal_data(), External_or_internal_data_index_of_traded_pressure, Index_of_traded_pressure_value, Prescribed_volume_pt, and Traded_pressure_stored_as_internal_data.

◆ VolumeConstraintElement() [2/2]

oomph::VolumeConstraintElement::VolumeConstraintElement	(	double *	prescribed_volume_pt,
		Data *	p_traded_data_pt,
		const unsigned &	index_of_traded_pressure
	)

Constructor: Pass pointer to target volume, pointer to Data item whose value specified by index_of_traded_pressure represents the "Pressure" value that "traded" for the volume contraint. The Data is stored as external Data for this element.

   {
     // Store pointer to prescribed volume
     Prescribed_volume_pt = prescribed_volume_pt;
  
     // Add as external data and record the index
     External_or_internal_data_index_of_traded_pressure =
       add_external_data(p_traded_data_pt);
  
     // Record that it is external data
     Traded_pressure_stored_as_internal_data = false;
  
     // Record index
     Index_of_traded_pressure_value = index_of_traded_pressure;
   }

References oomph::GeneralisedElement::add_external_data(), External_or_internal_data_index_of_traded_pressure, index_of_traded_pressure(), Index_of_traded_pressure_value, p_traded_data_pt(), Prescribed_volume_pt, and Traded_pressure_stored_as_internal_data.

◆ ~VolumeConstraintElement()

oomph::VolumeConstraintElement::~VolumeConstraintElement ( )

inline

Empty destructor.

121 {}

Member Function Documentation

◆ fill_in_contribution_to_jacobian()

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

inlinevirtual

Fill in the residuals and jacobian for the volume constraint.

Reimplemented from oomph::GeneralisedElement.

     {
       // No contribution to jacobian; see comment in that function
       this->fill_in_generic_contribution_to_residuals_volume_constraint(
         residuals);
     }

References fill_in_generic_contribution_to_residuals_volume_constraint().

◆ fill_in_contribution_to_jacobian_and_mass_matrix()

void oomph::VolumeConstraintElement::fill_in_contribution_to_jacobian_and_mass_matrix	(	Vector< double > &	residuals,
		DenseMatrix< double > &	jacobian,
		DenseMatrix< double > &	mass_matrix
	)

inlinevirtual

Fill in the residuals, jacobian and mass matrix for the volume constraint.

Reimplemented from oomph::GeneralisedElement.

     {
       // No contribution to jacobian or mass matrix; see comment in that
       // function
       this->fill_in_generic_contribution_to_residuals_volume_constraint(
         residuals);
     }

References fill_in_generic_contribution_to_residuals_volume_constraint().

◆ fill_in_contribution_to_residuals()

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

inlinevirtual

Fill in the residuals for the volume constraint.

Reimplemented from oomph::GeneralisedElement.

     {
       this->fill_in_generic_contribution_to_residuals_volume_constraint(
         residuals);
     }

References fill_in_generic_contribution_to_residuals_volume_constraint().

◆ fill_in_generic_contribution_to_residuals_volume_constraint()

void oomph::VolumeConstraintElement::fill_in_generic_contribution_to_residuals_volume_constraint ( Vector< double > & residuals )

private

Fill in the residuals for the volume constraint.

   {
     // Note: This element can only be used with the associated
     // VolumeConstraintBoundingElement elements which compute the actual
     // enclosed volume; here we only add the contribution to the
     // residual; everything else, incl. the derivatives of this
     // residual w.r.t. the nodal positions of the
     // VolumeConstraintBoundingElements
     // is handled by them
     const int local_eqn = this->ptraded_local_eqn();
     if (local_eqn >= 0)
     {
       residuals[local_eqn] -= *Prescribed_volume_pt;
     }
   }

References Prescribed_volume_pt, and ptraded_local_eqn().

Referenced by fill_in_contribution_to_jacobian(), fill_in_contribution_to_jacobian_and_mass_matrix(), and fill_in_contribution_to_residuals().

◆ index_of_traded_pressure()

unsigned oomph::VolumeConstraintElement::index_of_traded_pressure ( )

inline

Return the index of Data object at which the traded pressure is stored.

     {
       return Index_of_traded_pressure_value;
     }

References Index_of_traded_pressure_value.

Referenced by oomph::VolumeConstraintBoundingElement::set_volume_constraint_element(), and VolumeConstraintElement().

◆ p_traded()

double oomph::VolumeConstraintElement::p_traded ( )

inline

Return the traded pressure value.

     {
       return p_traded_data_pt()->value(Index_of_traded_pressure_value);
     }

References Index_of_traded_pressure_value, p_traded_data_pt(), and oomph::Data::value().

◆ p_traded_data_pt()

Data* oomph::VolumeConstraintElement::p_traded_data_pt ( )

inline

Access to Data that contains the traded pressure.

     {
       if (Traded_pressure_stored_as_internal_data)
       {
         return internal_data_pt(
           External_or_internal_data_index_of_traded_pressure);
       }
       else
       {
         return external_data_pt(
           External_or_internal_data_index_of_traded_pressure);
       }
     }

References oomph::GeneralisedElement::external_data_pt(), External_or_internal_data_index_of_traded_pressure, oomph::GeneralisedElement::internal_data_pt(), and Traded_pressure_stored_as_internal_data.

Referenced by p_traded(), oomph::VolumeConstraintBoundingElement::set_volume_constraint_element(), and VolumeConstraintElement().

◆ ptraded_local_eqn()

int oomph::VolumeConstraintElement::ptraded_local_eqn ( )

inlineprivate

The local eqn number for the traded pressure.

     {
       if (Traded_pressure_stored_as_internal_data)
       {
         return this->internal_local_eqn(
           External_or_internal_data_index_of_traded_pressure,
           Index_of_traded_pressure_value);
       }
       else
       {
         return this->external_local_eqn(
           External_or_internal_data_index_of_traded_pressure,
           Index_of_traded_pressure_value);
       }
     }

References oomph::GeneralisedElement::external_local_eqn(), Index_of_traded_pressure_value, oomph::GeneralisedElement::internal_local_eqn(), and Traded_pressure_stored_as_internal_data.

Referenced by fill_in_generic_contribution_to_residuals_volume_constraint().

Member Data Documentation

◆ External_or_internal_data_index_of_traded_pressure

unsigned oomph::VolumeConstraintElement::External_or_internal_data_index_of_traded_pressure

private

The Data that contains the traded pressure is stored as external or internal Data for the element. What is its index in these containers?

Referenced by p_traded_data_pt(), and VolumeConstraintElement().

◆ Index_of_traded_pressure_value

unsigned oomph::VolumeConstraintElement::Index_of_traded_pressure_value

private

Index of the value in traded pressure data that corresponds to the traded pressure

Referenced by index_of_traded_pressure(), p_traded(), ptraded_local_eqn(), and VolumeConstraintElement().

◆ Prescribed_volume_pt

double* oomph::VolumeConstraintElement::Prescribed_volume_pt

private

Pointer to the desired value of the volume.

Referenced by fill_in_generic_contribution_to_residuals_volume_constraint(), and VolumeConstraintElement().

◆ Traded_pressure_stored_as_internal_data

bool oomph::VolumeConstraintElement::Traded_pressure_stored_as_internal_data

private

The Data that contains the traded pressure is stored as external or internal Data for the element. Which one?

Referenced by p_traded_data_pt(), ptraded_local_eqn(), and VolumeConstraintElement().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VolumeConstraintElement() [1/2]

◆ VolumeConstraintElement() [2/2]

◆ ~VolumeConstraintElement()

Member Function Documentation

◆ fill_in_contribution_to_jacobian()

◆ fill_in_contribution_to_jacobian_and_mass_matrix()

◆ fill_in_contribution_to_residuals()

◆ fill_in_generic_contribution_to_residuals_volume_constraint()

◆ index_of_traded_pressure()

◆ p_traded()

◆ p_traded_data_pt()

◆ ptraded_local_eqn()

Member Data Documentation

◆ External_or_internal_data_index_of_traded_pressure

◆ Index_of_traded_pressure_value

◆ Prescribed_volume_pt

◆ Traded_pressure_stored_as_internal_data