#include <pseudo_elastic_preconditioner.h>

Inheritance diagram for oomph::PseudoElasticPreconditionerSubsidiaryPreconditionerOld:

Public Types
typedef Preconditioner (	SubsidiaryPreconditionerFctPt) ()

Public Member Functions
	PseudoElasticPreconditionerSubsidiaryPreconditionerOld ()
	Constructor. More...

	~PseudoElasticPreconditionerSubsidiaryPreconditionerOld ()
	Destructor. More...

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

void	setup ()
	Broken assignment operator. More...

void	preconditioner_solve (const DoubleVector &r, DoubleVector &z)
	Apply the preconditioner. More...

double &	scaling ()

void	set_subsidiary_preconditioner_function (SubsidiaryPreconditionerFctPt sub_prec_fn)
	access function to set the subsidiary preconditioner function. More...

Public Member Functions inherited from oomph::BlockPreconditioner< CRDoubleMatrix >
	BlockPreconditioner ()
	Constructor. More...

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

virtual	~BlockPreconditioner ()
	Destructor. More...

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

CRDoubleMatrix *	matrix_pt () const

void	turn_on_recursive_debug_flag ()

void	turn_off_recursive_debug_flag ()

void	turn_on_debug_flag ()
	Toggles on the debug flag. More...

void	turn_off_debug_flag ()
	Toggles off the debug flag. More...

void	turn_into_subsidiary_block_preconditioner (BlockPreconditioner< CRDoubleMatrix > *master_block_prec_pt, const Vector< unsigned > &doftype_in_master_preconditioner_coarse)

void	turn_into_subsidiary_block_preconditioner (BlockPreconditioner< CRDoubleMatrix > *master_block_prec_pt, const Vector< unsigned > &doftype_in_master_preconditioner_coarse, const Vector< Vector< unsigned >> &doftype_coarsen_map_coarse)

virtual void	block_setup ()

void	block_setup (const Vector< unsigned > &dof_to_block_map)

void	get_block (const unsigned &i, const unsigned &j, CRDoubleMatrix &output_matrix, const bool &ignore_replacement_block=false) const

CRDoubleMatrix	get_block (const unsigned &i, const unsigned &j, const bool &ignore_replacement_block=false) const

void	set_master_matrix_pt (CRDoubleMatrix *in_matrix_pt)
	Set the matrix_pt in the upper-most master preconditioner. More...

void	get_block_other_matrix (const unsigned &i, const unsigned &j, CRDoubleMatrix *in_matrix_pt, CRDoubleMatrix &output_matrix)

void	get_blocks (DenseMatrix< bool > &required_blocks, DenseMatrix< CRDoubleMatrix * > &block_matrix_pt) const

void	get_dof_level_block (const unsigned &i, const unsigned &j, CRDoubleMatrix &output_block, const bool &ignore_replacement_block=false) const

void	get_dof_level_block (const unsigned &block_i, const unsigned &block_j, CRDoubleMatrix &output_block, const bool &ignore_replacement_block) const

CRDoubleMatrix	get_concatenated_block (const VectorMatrix< BlockSelector > &selected_block)

void	get_concatenated_block_vector (const Vector< unsigned > &block_vec_number, const DoubleVector &v, DoubleVector &b)

void	return_concatenated_block_vector (const Vector< unsigned > &block_vec_number, const DoubleVector &b, DoubleVector &v) const
	Takes concatenated block ordered vector, b, and copies its. More...

void	get_block_vectors (const Vector< unsigned > &block_vec_number, const DoubleVector &v, Vector< DoubleVector > &s) const

void	get_block_vectors (const DoubleVector &v, Vector< DoubleVector > &s) const

void	return_block_vectors (const Vector< unsigned > &block_vec_number, const Vector< DoubleVector > &s, DoubleVector &v) const

void	return_block_vectors (const Vector< DoubleVector > &s, DoubleVector &v) const

void	get_block_vector (const unsigned &n, const DoubleVector &v, DoubleVector &b) const

void	return_block_vector (const unsigned &n, const DoubleVector &b, DoubleVector &v) const

void	get_block_ordered_preconditioner_vector (const DoubleVector &v, DoubleVector &w)

void	return_block_ordered_preconditioner_vector (const DoubleVector &w, DoubleVector &v) const

unsigned	nblock_types () const
	Return the number of block types. More...

unsigned	ndof_types () const
	Return the total number of DOF types. More...

const Mesh *	mesh_pt (const unsigned &i) const

unsigned	nmesh () const

int	block_number (const unsigned &i_dof) const
	Return the block number corresponding to a global index i_dof. More...

int	index_in_block (const unsigned &i_dof) const

const LinearAlgebraDistribution *	block_distribution_pt (const unsigned &b) const
	Access function to the block distributions (const version). More...

LinearAlgebraDistribution *	block_distribution_pt (const unsigned b)
	Access function to the block distributions (non-const version). More...

LinearAlgebraDistribution *	dof_block_distribution_pt (const unsigned &b)
	Access function to the dof-level block distributions. More...

const LinearAlgebraDistribution *	master_distribution_pt () const

unsigned	ndof_types_in_mesh (const unsigned &i) const

bool	is_subsidiary_block_preconditioner () const

bool	is_master_block_preconditioner () const

void	set_block_output_to_files (const std::string &basefilename)

void	disable_block_output_to_files ()
	Turn off output of blocks (by clearing the basefilename string). More...

bool	block_output_on () const
	Test if output of blocks is on or not. More...

void	output_blocks_to_files (const std::string &basefilename, const unsigned &precision=8) const

void	post_block_matrix_assembly_partial_clear ()

BlockPreconditioner< CRDoubleMatrix > *	master_block_preconditioner_pt () const
	Access function to the master block preconditioner pt. More...

void	clear_block_preconditioner_base ()

void	document ()

Vector< Vector< unsigned > >	doftype_coarsen_map_fine () const

Vector< unsigned >	get_fine_grain_dof_types_in (const unsigned &i) const

unsigned	nfine_grain_dof_types_in (const unsigned &i) const

MapMatrix< unsigned, CRDoubleMatrix * >	replacement_dof_block_pt () const
	Access function to the replaced dof-level blocks. More...

void	setup_matrix_vector_product (MatrixVectorProduct matvec_prod_pt, CRDoubleMatrix block_pt, const Vector< unsigned > &block_col_indices)

void	setup_matrix_vector_product (MatrixVectorProduct matvec_prod_pt, CRDoubleMatrix block_pt, const unsigned &block_col_index)

void	internal_get_block_ordered_preconditioner_vector (const DoubleVector &v, DoubleVector &w) const

void	internal_return_block_ordered_preconditioner_vector (const DoubleVector &w, DoubleVector &v) const

unsigned	internal_nblock_types () const

unsigned	internal_ndof_types () const

void	internal_return_block_vector (const unsigned &n, const DoubleVector &b, DoubleVector &v) const

void	internal_get_block_vector (const unsigned &n, const DoubleVector &v, DoubleVector &b) const

void	internal_get_block_vectors (const Vector< unsigned > &block_vec_number, const DoubleVector &v, Vector< DoubleVector > &s) const

void	internal_get_block_vectors (const DoubleVector &v, Vector< DoubleVector > &s) const

void	internal_return_block_vectors (const Vector< unsigned > &block_vec_number, const Vector< DoubleVector > &s, DoubleVector &v) const

void	internal_return_block_vectors (const Vector< DoubleVector > &s, DoubleVector &v) const

void	internal_get_block (const unsigned &i, const unsigned &j, CRDoubleMatrix &output_block) const

void	internal_get_block (const unsigned &block_i, const unsigned &block_j, CRDoubleMatrix &output_block) const

int	internal_block_number (const unsigned &i_dof) const

int	internal_index_in_block (const unsigned &i_dof) const

const LinearAlgebraDistribution *	internal_block_distribution_pt (const unsigned &b) const
	Access function to the internal block distributions. More...

void	insert_auxiliary_block_distribution (const Vector< unsigned > &block_vec_number, LinearAlgebraDistribution *dist_pt)

void	block_matrix_test (const unsigned &i, const unsigned &j, const CRDoubleMatrix *block_matrix_pt) const

int	get_index_of_value (const Vector< myType > &vec, const myType val, const bool sorted=false) const

Public Member Functions inherited from oomph::Preconditioner
	Preconditioner ()
	Constructor. More...

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

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

virtual	~Preconditioner ()
	Destructor (empty) More...

virtual void	preconditioner_solve_transpose (const DoubleVector &r, DoubleVector &z)

void	setup (DoubleMatrixBase *matrix_pt)

void	setup (const Problem problem_pt, DoubleMatrixBase matrix_pt)

void	enable_silent_preconditioner_setup ()
	Set up the block preconditioner quietly! More...

void	disable_silent_preconditioner_setup ()
	Be verbose in the block preconditioner setup. More...

virtual void	set_matrix_pt (DoubleMatrixBase *matrix_pt)
	Set the matrix pointer. More...

virtual const OomphCommunicator *	comm_pt () const
	Get function for comm pointer. More...

virtual void	set_comm_pt (const OomphCommunicator *const comm_pt)
	Set the communicator pointer. More...

double	setup_time () const
	Returns the time to setup the preconditioner. More...

virtual void	turn_into_subsidiary_block_preconditioner (BlockPreconditioner< CRDoubleMatrix > *master_block_prec_pt, const Vector< unsigned > &doftype_in_master_preconditioner_coarse)

virtual void	turn_into_subsidiary_block_preconditioner (BlockPreconditioner< CRDoubleMatrix > *master_block_prec_pt, const Vector< unsigned > &doftype_in_master_preconditioner_coarse, const Vector< Vector< unsigned >> &doftype_coarsen_map_coarse)

Public Member Functions inherited from oomph::DistributableLinearAlgebraObject
	DistributableLinearAlgebraObject ()
	Default constructor - create a distribution. More...

	DistributableLinearAlgebraObject (const DistributableLinearAlgebraObject &matrix)=delete
	Broken copy constructor. More...

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

virtual	~DistributableLinearAlgebraObject ()
	Destructor. More...

LinearAlgebraDistribution *	distribution_pt () const
	access to the LinearAlgebraDistribution More...

unsigned	nrow () const
	access function to the number of global rows. More...

unsigned	nrow_local () const
	access function for the num of local rows on this processor. More...

unsigned	nrow_local (const unsigned &p) const
	access function for the num of local rows on this processor. More...

unsigned	first_row () const
	access function for the first row on this processor More...

unsigned	first_row (const unsigned &p) const
	access function for the first row on this processor More...

bool	distributed () const
	distribution is serial or distributed More...

bool	distribution_built () const

void	build_distribution (const LinearAlgebraDistribution *const dist_pt)

void	build_distribution (const LinearAlgebraDistribution &dist)

Private Member Functions
void	clean_up_memory ()
	clears the memory More...

Private Attributes
double	Scaling

Preconditioner *	Preconditioner_pt
	the preconditioner pt More...

SubsidiaryPreconditionerFctPt	Subsidiary_preconditioner_function_pt
	the SubisidaryPreconditionerFctPt More...

Additional Inherited Members
Protected Member Functions inherited from oomph::BlockPreconditioner< CRDoubleMatrix >
void	set_nmesh (const unsigned &n)

void	set_mesh (const unsigned &i, const Mesh *const mesh_pt, const bool &allow_multiple_element_type_in_mesh=false)

void	set_replacement_dof_block (const unsigned &block_i, const unsigned &block_j, CRDoubleMatrix *replacement_dof_block_pt)

bool	any_mesh_distributed () const

int	internal_dof_number (const unsigned &i_dof) const

unsigned	internal_index_in_dof (const unsigned &i_dof) const

unsigned	internal_block_dimension (const unsigned &b) const

unsigned	internal_dof_block_dimension (const unsigned &i) const

unsigned	master_nrow () const

unsigned	internal_master_dof_number (const unsigned &b) const

const LinearAlgebraDistribution *	internal_preconditioner_matrix_distribution_pt () const

const LinearAlgebraDistribution *	preconditioner_matrix_distribution_pt () const

Protected Member Functions inherited from oomph::DistributableLinearAlgebraObject
void	clear_distribution ()

Protected Attributes inherited from oomph::BlockPreconditioner< CRDoubleMatrix >
MapMatrix< unsigned, CRDoubleMatrix * >	Replacement_dof_block_pt
	The replacement dof-level blocks. More...

Vector< LinearAlgebraDistribution * >	Block_distribution_pt
	The distribution for the blocks. More...

Vector< Vector< unsigned > >	Block_to_dof_map_coarse

Vector< Vector< unsigned > >	Block_to_dof_map_fine
	Mapping for the block types to the most fine grain dof types. More...

Vector< Vector< unsigned > >	Doftype_coarsen_map_coarse

Vector< Vector< unsigned > >	Doftype_coarsen_map_fine

Vector< LinearAlgebraDistribution * >	Internal_block_distribution_pt
	Storage for the default distribution for each internal block. More...

Vector< LinearAlgebraDistribution * >	Dof_block_distribution_pt

Vector< unsigned >	Allow_multiple_element_type_in_mesh

Vector< const Mesh * >	Mesh_pt

Vector< unsigned >	Ndof_types_in_mesh

unsigned	Internal_nblock_types

unsigned	Internal_ndof_types

Protected Attributes inherited from oomph::Preconditioner
bool	Silent_preconditioner_setup
	Boolean to indicate whether or not the build should be done silently. More...

std::ostream *	Stream_pt
	Pointer to the output stream – defaults to std::cout. More...

Detailed Description

///////////////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////////////// Subsidiary helper preconditioner for the PseudoElasticPreconditioner. Required to construct the augmented elastic system prior to preconditioning. NOTE:

This is only intended to be used as a subsidiary preconditioner within the PseudoElasticPreconditioner.
If this preconditioner has N DOF types then the first N/2 are assumed to be ordinary solid DOF types, and the second N/2 are the solid DOF types with lagrange multiplier tractions applied.
By default this preconditioner uses a superlu preconditioner.

Member Typedef Documentation

◆ SubsidiaryPreconditionerFctPt

typedef Preconditioner*(* oomph::PseudoElasticPreconditionerSubsidiaryPreconditionerOld::SubsidiaryPreconditionerFctPt) ()

typedef for a function that allows other preconditioners to be emplyed to solve the subsidiary linear systems. The function should return a pointer to the requred subsidiary preconditioner generated using new. This preconditioner is responsible for the destruction of the subsidiary preconditioners.

Constructor & Destructor Documentation

◆ PseudoElasticPreconditionerSubsidiaryPreconditionerOld() [1/2]

oomph::PseudoElasticPreconditionerSubsidiaryPreconditionerOld::PseudoElasticPreconditionerSubsidiaryPreconditionerOld ( )

inline

Constructor.

     {
       Scaling = 1.0;
       Preconditioner_pt = 0;
       Subsidiary_preconditioner_function_pt = 0;
     }

References Preconditioner_pt, Scaling, and Subsidiary_preconditioner_function_pt.

◆ ~PseudoElasticPreconditionerSubsidiaryPreconditionerOld()

oomph::PseudoElasticPreconditionerSubsidiaryPreconditionerOld::~PseudoElasticPreconditionerSubsidiaryPreconditionerOld ( )

inline

Destructor.

     {
       this->clean_up_memory();
     }

References clean_up_memory().

◆ PseudoElasticPreconditionerSubsidiaryPreconditionerOld() [2/2]

oomph::PseudoElasticPreconditionerSubsidiaryPreconditionerOld::PseudoElasticPreconditionerSubsidiaryPreconditionerOld ( const PseudoElasticPreconditionerSubsidiaryPreconditionerOld & )

delete

Broken copy constructor.

Member Function Documentation

◆ clean_up_memory()

void oomph::PseudoElasticPreconditionerSubsidiaryPreconditionerOld::clean_up_memory ( )

inlineprivatevirtual

clears the memory

Reimplemented from oomph::Preconditioner.

     {
       delete Preconditioner_pt;
       Preconditioner_pt = 0;
     }

References Preconditioner_pt.

Referenced by setup(), and ~PseudoElasticPreconditionerSubsidiaryPreconditionerOld().

◆ preconditioner_solve()

void oomph::PseudoElasticPreconditionerSubsidiaryPreconditionerOld::preconditioner_solve	(	const DoubleVector &	r,
		DoubleVector &	z
	)

virtual

Apply the preconditioner.

Implements oomph::Preconditioner.

   {
     DoubleVector x;
     this->get_block_ordered_preconditioner_vector(r, x);
     DoubleVector y;
     Preconditioner_pt->preconditioner_solve(x, y);
     this->return_block_ordered_preconditioner_vector(y, z);
   }

References oomph::BlockPreconditioner< CRDoubleMatrix >::get_block_ordered_preconditioner_vector(), Preconditioner_pt, oomph::Preconditioner::preconditioner_solve(), oomph::BlockPreconditioner< CRDoubleMatrix >::return_block_ordered_preconditioner_vector(), plotDoE::x, and y.

◆ scaling()

double& oomph::PseudoElasticPreconditionerSubsidiaryPreconditionerOld::scaling ( )

inline

Specify the scaling. Default is 1.0 Must be called before setup(...).

     {
       return Scaling;
     }

References Scaling.

Referenced by oomph::PseudoElasticPreconditionerOld::setup().

◆ set_subsidiary_preconditioner_function()

void oomph::PseudoElasticPreconditionerSubsidiaryPreconditionerOld::set_subsidiary_preconditioner_function ( SubsidiaryPreconditionerFctPt sub_prec_fn )

inline

access function to set the subsidiary preconditioner function.

     {
       Subsidiary_preconditioner_function_pt = sub_prec_fn;
     }

References Subsidiary_preconditioner_function_pt.

Referenced by oomph::PseudoElasticPreconditionerOld::setup().

◆ setup()

void oomph::PseudoElasticPreconditionerSubsidiaryPreconditionerOld::setup ( )

virtual

Broken assignment operator.

Setup the preconditioner.

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

Implements oomph::Preconditioner.

   {
     // clean memory
     this->clean_up_memory();
  
 #ifdef PARANOID
     // paranoid check that this preconditioner has an even number of DOF types
     if (this->ndof_types() % 2 != 0)
     {
       std::ostringstream error_message;
       error_message
         << "This SUBSIDIARY preconditioner requires an even number of "
         << "types of DOF";
       throw OomphLibError(
         error_message.str(), OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION);
     }
 #endif
  
     // assemble dof_to_block_map
     unsigned ndof_types = this->ndof_types();
     Vector<unsigned> dof_to_block_map(ndof_types, 0);
     for (unsigned i = ndof_types / 2; i < ndof_types; i++)
     {
       dof_to_block_map[i] = 1;
     }
  
     this->block_setup(dof_to_block_map);
  
     // get block 11
     CRDoubleMatrix* s11_pt = new CRDoubleMatrix;
     this->get_block(1, 1, *s11_pt);
  
     // add the scaled identity matrix to block 11
     double* s11_values = s11_pt->value();
     int* s11_column_index = s11_pt->column_index();
     int* s11_row_start = s11_pt->row_start();
     int s11_nrow_local = s11_pt->nrow_local();
     int s11_first_row = s11_pt->first_row();
     for (int i = 0; i < s11_nrow_local; i++)
     {
       bool found = false;
       for (int j = s11_row_start[i]; j < s11_row_start[i + 1] && !found; j++)
       {
         if (s11_column_index[j] == i + s11_first_row)
         {
           s11_values[j] += Scaling;
           found = true;
         }
       }
     }
  
     VectorMatrix<BlockSelector> required_blocks(2, 2);
     const bool want_block = true;
     for (unsigned b_i = 0; b_i < 2; b_i++)
     {
       for (unsigned b_j = 0; b_j < 2; b_j++)
       {
         required_blocks[b_i][b_j].select_block(b_i, b_j, want_block);
       }
     }
  
     required_blocks[1][1].set_replacement_block_pt(s11_pt);
  
     CRDoubleMatrix s_prec_pt = this->get_concatenated_block(required_blocks);
  
     delete s11_pt;
     s11_pt = 0;
  
     // setup the preconditioner
     if (Subsidiary_preconditioner_function_pt != 0)
     {
       Preconditioner_pt = (*Subsidiary_preconditioner_function_pt)();
     }
     else
     {
       Preconditioner_pt = new SuperLUPreconditioner;
     }
     Preconditioner_pt->setup(&s_prec_pt);
   }

References oomph::BlockPreconditioner< CRDoubleMatrix >::block_setup(), clean_up_memory(), oomph::CRDoubleMatrix::column_index(), oomph::DistributableLinearAlgebraObject::first_row(), MergeRestartFiles::found, oomph::BlockPreconditioner< CRDoubleMatrix >::get_block(), oomph::BlockPreconditioner< CRDoubleMatrix >::get_concatenated_block(), i, j, oomph::BlockPreconditioner< CRDoubleMatrix >::ndof_types(), oomph::DistributableLinearAlgebraObject::nrow_local(), OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION, Preconditioner_pt, oomph::CRDoubleMatrix::row_start(), Scaling, oomph::Preconditioner::setup(), Subsidiary_preconditioner_function_pt, and oomph::CRDoubleMatrix::value().

Member Data Documentation

◆ Preconditioner_pt

Preconditioner* oomph::PseudoElasticPreconditionerSubsidiaryPreconditionerOld::Preconditioner_pt

private

the preconditioner pt

Referenced by clean_up_memory(), preconditioner_solve(), PseudoElasticPreconditionerSubsidiaryPreconditionerOld(), and setup().

◆ Scaling

double oomph::PseudoElasticPreconditionerSubsidiaryPreconditionerOld::Scaling

private

Referenced by PseudoElasticPreconditionerSubsidiaryPreconditionerOld(), scaling(), and setup().

◆ Subsidiary_preconditioner_function_pt

SubsidiaryPreconditionerFctPt oomph::PseudoElasticPreconditionerSubsidiaryPreconditionerOld::Subsidiary_preconditioner_function_pt

private

the SubisidaryPreconditionerFctPt

Referenced by PseudoElasticPreconditionerSubsidiaryPreconditionerOld(), set_subsidiary_preconditioner_function(), and setup().

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SubsidiaryPreconditionerFctPt

Constructor & Destructor Documentation

◆ PseudoElasticPreconditionerSubsidiaryPreconditionerOld() [1/2]

◆ ~PseudoElasticPreconditionerSubsidiaryPreconditionerOld()

◆ PseudoElasticPreconditionerSubsidiaryPreconditionerOld() [2/2]

Member Function Documentation

◆ clean_up_memory()

◆ preconditioner_solve()

◆ scaling()

◆ set_subsidiary_preconditioner_function()

◆ setup()

Member Data Documentation

◆ Preconditioner_pt

◆ Scaling

◆ Subsidiary_preconditioner_function_pt