oomph::TwoPlusThreeUpperTriangular< MATRIX > Class Template Reference

#include <multi_poisson_block_preconditioners.h>

+ Inheritance diagram for oomph::TwoPlusThreeUpperTriangular< MATRIX >:

Public Member Functions

 TwoPlusThreeUpperTriangular ()
 Constructor. More...
 
virtual ~TwoPlusThreeUpperTriangular ()
 Destructor - delete the preconditioner matrices. More...
 
virtual void clean_up_my_memory ()
 clean up the memory More...
 
 TwoPlusThreeUpperTriangular (const TwoPlusThreeUpperTriangular &)
 Broken copy constructor. More...
 
void operator= (const TwoPlusThreeUpperTriangular &)
 Broken assignment operator. More...
 
void preconditioner_solve (const DoubleVector &r, DoubleVector &z)
 Apply preconditioner to r. More...
 
void setup ()
 Setup the preconditioner. More...
 
void set_multi_poisson_mesh (Mesh *multi_poisson_mesh_pt)
 Specify the mesh that contains multi-poisson elements. More...
 
void setup (DoubleMatrixBase *matrix_pt)
 
void setup (const Problem *problem_pt, DoubleMatrixBase *matrix_pt)
 
virtual void setup ()=0
 
- Public Member Functions inherited from oomph::BlockPreconditioner< MATRIX >
 BlockPreconditioner ()
 Constructor. More...
 
virtual ~BlockPreconditioner ()
 Destructor. More...
 
 BlockPreconditioner (const BlockPreconditioner &)=delete
 Broken copy constructor. More...
 
void operator= (const BlockPreconditioner &)=delete
 Broken assignment operator. More...
 
MATRIX * 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< MATRIX > *master_block_prec_pt, const Vector< unsigned > &doftype_in_master_preconditioner_coarse)
 
void turn_into_subsidiary_block_preconditioner (BlockPreconditioner< MATRIX > *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, MATRIX &output_matrix, const bool &ignore_replacement_block=false) const
 
MATRIX get_block (const unsigned &i, const unsigned &j, const bool &ignore_replacement_block=false) const
 
void set_master_matrix_pt (MATRIX *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, MATRIX *in_matrix_pt, MATRIX &output_matrix)
 
void get_blocks (DenseMatrix< bool > &required_blocks, DenseMatrix< MATRIX * > &block_matrix_pt) const
 
void get_dof_level_block (const unsigned &i, const unsigned &j, MATRIX &output_block, const bool &ignore_replacement_block=false) const
 
MATRIX 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 Meshmesh_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 LinearAlgebraDistributionblock_distribution_pt (const unsigned &b) const
 Access function to the block distributions (const version). More...
 
LinearAlgebraDistributionblock_distribution_pt (const unsigned b)
 Access function to the block distributions (non-const version). More...
 
LinearAlgebraDistributiondof_block_distribution_pt (const unsigned &b)
 Access function to the dof-level block distributions. More...
 
const LinearAlgebraDistributionmaster_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< MATRIX > * 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< unsignedget_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, MATRIX &output_block) const
 
int internal_block_number (const unsigned &i_dof) const
 
int internal_index_in_block (const unsigned &i_dof) const
 
const LinearAlgebraDistributioninternal_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 MATRIX *block_matrix_pt) const
 
template<typename myType >
int get_index_of_value (const Vector< myType > &vec, const myType val, const bool sorted=false) const
 
void internal_get_block (const unsigned &block_i, const unsigned &block_j, CRDoubleMatrix &output_block) const
 
void get_dof_level_block (const unsigned &block_i, const unsigned &block_j, CRDoubleMatrix &output_block, const bool &ignore_replacement_block) 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 clean_up_memory ()
 Clean up memory (empty). Generic interface function. More...
 
virtual void set_matrix_pt (DoubleMatrixBase *matrix_pt)
 Set the matrix pointer. More...
 
virtual const OomphCommunicatorcomm_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...
 
LinearAlgebraDistributiondistribution_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 Attributes

MatrixVectorProductOff_diagonal_matrix_vector_product_pt
 Pointer to matrix vector product operator for the single off diagonals. More...
 
PreconditionerFirst_subsidiary_preconditioner_pt
 
PreconditionerSecond_subsidiary_preconditioner_pt
 
MeshMulti_poisson_mesh_pt
 

Additional Inherited Members

- Protected Member Functions inherited from oomph::BlockPreconditioner< MATRIX >
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 LinearAlgebraDistributioninternal_preconditioner_matrix_distribution_pt () const
 
const LinearAlgebraDistributionpreconditioner_matrix_distribution_pt () const
 
- Protected Member Functions inherited from oomph::DistributableLinearAlgebraObject
void clear_distribution ()
 
- Protected Attributes inherited from oomph::BlockPreconditioner< MATRIX >
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< unsignedAllow_multiple_element_type_in_mesh
 
Vector< const Mesh * > Mesh_pt
 
Vector< unsignedNdof_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

template<typename MATRIX>
class oomph::TwoPlusThreeUpperTriangular< MATRIX >

///////////////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////////////// Upper triangular two plus three triangular preconditioner for a system with 5 dof types.

Constructor & Destructor Documentation

◆ TwoPlusThreeUpperTriangular() [1/2]

template<typename MATRIX >
oomph::TwoPlusThreeUpperTriangular< MATRIX >::TwoPlusThreeUpperTriangular ( )
inline

Constructor.

1295  :
1296  BlockPreconditioner<MATRIX>(),
1300  {
1302  }
MatrixVectorProduct * Off_diagonal_matrix_vector_product_pt
Pointer to matrix vector product operator for the single off diagonals.
Definition: multi_poisson_block_preconditioners.h:1344
Preconditioner * First_subsidiary_preconditioner_pt
Definition: multi_poisson_block_preconditioners.h:1348
Mesh * Multi_poisson_mesh_pt
Definition: multi_poisson_block_preconditioners.h:1356
Preconditioner * Second_subsidiary_preconditioner_pt
Definition: multi_poisson_block_preconditioners.h:1352

References oomph::TwoPlusThreeUpperTriangular< MATRIX >::Multi_poisson_mesh_pt.

◆ ~TwoPlusThreeUpperTriangular()

template<typename MATRIX >
virtual oomph::TwoPlusThreeUpperTriangular< MATRIX >::~TwoPlusThreeUpperTriangular ( )
inlinevirtual

Destructor - delete the preconditioner matrices.

1306  {
1307  this->clean_up_my_memory();
1308  }
virtual void clean_up_my_memory()
clean up the memory
Definition: multi_poisson_block_preconditioners.h:1498

References oomph::TwoPlusThreeUpperTriangular< MATRIX >::clean_up_my_memory().

◆ TwoPlusThreeUpperTriangular() [2/2]

template<typename MATRIX >
oomph::TwoPlusThreeUpperTriangular< MATRIX >::TwoPlusThreeUpperTriangular ( const TwoPlusThreeUpperTriangular< MATRIX > &  )
inline

Broken copy constructor.

1315  {
1316  BrokenCopy::broken_copy("TwoPlusThreeUpperTriangular");
1317  }
void broken_copy(const std::string &class_name)
Issue error message and terminate execution.
Definition: oomph_utilities.cc:212

References oomph::BrokenCopy::broken_copy().

Member Function Documentation

◆ clean_up_my_memory()

template<typename MATRIX >
void oomph::TwoPlusThreeUpperTriangular< MATRIX >::clean_up_my_memory
virtual

clean up the memory

The clean up function.

1499  {
1500  // Delete of diagonal matrix vector product
1502  {
1505  }
1506 
1507  //Clean up subsidiary preconditioners.
1509  {
1512  }
1514  {
1517  }
1518  } // End of clean_up_my_memory function.

Referenced by oomph::TwoPlusThreeUpperTriangular< MATRIX >::~TwoPlusThreeUpperTriangular().

◆ operator=()

template<typename MATRIX >
void oomph::TwoPlusThreeUpperTriangular< MATRIX >::operator= ( const TwoPlusThreeUpperTriangular< MATRIX > &  )
inline

Broken assignment operator.

1321  {
1322  BrokenCopy::broken_assign("TwoPlusThreeUpperTriangular");
1323  }
void broken_assign(const std::string &class_name)
Issue error message and terminate execution.
Definition: oomph_utilities.cc:195

References oomph::BrokenCopy::broken_assign().

◆ preconditioner_solve()

template<typename MATRIX >
void oomph::TwoPlusThreeUpperTriangular< MATRIX >::preconditioner_solve ( const DoubleVector r,
DoubleVector z 
)
virtual

Apply preconditioner to r.

Preconditioner solve for the two plus three upper block triangular preconditioner: Apply preconditioner to r and return z, so that P z = r, where P is the block diagonal matrix constructed from the original linear system.

Implements oomph::Preconditioner.

1464  {
1465  // Get number of blocks
1466  unsigned n_block = this->nblock_types();
1467 
1468  // Split up rhs vector into sub-vectors, rarranged to match the matrix blocks.
1469  Vector<DoubleVector> block_r;
1470  this->get_block_vectors(r,block_r);
1471 
1472  // Create storage for solution of block solves
1473  Vector<DoubleVector> block_z(n_block);
1474 
1475  // Solve (1,1) diagonal block system
1477  block_z[1]);
1478 
1479  // Solve (0,1) off diagonal.
1480  // Substitute
1481  DoubleVector temp;
1483  block_r[0] -= temp;
1484 
1485  // Solve (0,0) diagonal block system
1487  block_z[0]);
1488 
1489  // Copy solution in block vectors block_z back to z
1490  this->return_block_vectors(block_z,z);
1491  }
std::vector< double > DoubleVector
loads clump configuration
Definition: ClumpInput.h:26
void return_block_vectors(const Vector< unsigned > &block_vec_number, const Vector< DoubleVector > &s, DoubleVector &v) const
Definition: block_preconditioner.cc:3443
unsigned nblock_types() const
Return the number of block types.
Definition: block_preconditioner.h:1670
void get_block_vectors(const Vector< unsigned > &block_vec_number, const DoubleVector &v, Vector< DoubleVector > &s) const
Definition: block_preconditioner.cc:2939
void multiply(const DoubleVector &x, DoubleVector &y) const
Definition: matrix_vector_product.cc:108
virtual void preconditioner_solve(const DoubleVector &r, DoubleVector &z)=0
r
Definition: UniformPSDSelfTest.py:20

References UniformPSDSelfTest::r.

◆ set_multi_poisson_mesh()

template<typename MATRIX >
void oomph::TwoPlusThreeUpperTriangular< MATRIX >::set_multi_poisson_mesh ( Mesh multi_poisson_mesh_pt)
inline

Specify the mesh that contains multi-poisson elements.

1337  {
1338  Multi_poisson_mesh_pt=multi_poisson_mesh_pt;
1339  }

References oomph::TwoPlusThreeUpperTriangular< MATRIX >::Multi_poisson_mesh_pt.

Referenced by MultiPoissonProblem< ELEMENT >::MultiPoissonProblem().

◆ setup() [1/4]

template<typename MATRIX >
void oomph::TwoPlusThreeUpperTriangular< MATRIX >::setup
virtual

Setup the preconditioner.

The setup function.

Implements oomph::Preconditioner.

1365  {
1366  // clean the memory
1367  this->clean_up_my_memory();
1368 
1369 #ifdef PARANOID
1370  if (Multi_poisson_mesh_pt == 0)
1371  {
1372  std::stringstream err;
1373  err << "Please set pointer to mesh using set_multi_poisson_mesh(...).\n";
1374  throw OomphLibError(err.str(),
1377  }
1378 #endif
1379 
1380  // The preconditioner works with one mesh; set it!
1381  this->set_nmesh(1);
1383 
1384  // Get number of degrees of freedom.
1385  unsigned n_dof_types = this->ndof_types();
1386 
1387 #ifdef PARANOID
1388  // This preconditioner only works for 5 dof types
1389  if (n_dof_types!=5)
1390  {
1391  std::stringstream tmp;
1392  tmp << "This preconditioner only works for problems with 5 dof types\n"
1393  << "Yours has " << n_dof_types;
1394  throw OomphLibError(tmp.str(),
1397  }
1398 #endif
1399 
1400  // Combine into two major blocks, one containing dof types 0 and 1, the
1401  // final one dof types 2-4. In general we want
1402  // dof_to_block_map[dof_type] = block_type
1403  Vector<unsigned> dof_to_block_map(n_dof_types);
1404  dof_to_block_map[0]=0;
1405  dof_to_block_map[1]=0;
1406  dof_to_block_map[2]=1;
1407  dof_to_block_map[3]=1;
1408  dof_to_block_map[4]=1;
1409  this->block_setup(dof_to_block_map);
1410 
1411  // Create the subsidiary preconditioners
1412  First_subsidiary_preconditioner_pt= new SuperLUPreconditioner;
1413  Second_subsidiary_preconditioner_pt= new SuperLUPreconditioner;
1414 
1415  // Set diagonal solvers/preconditioners; put in own scope
1416  // so block goes out of scope
1417  {
1418 
1419  CRDoubleMatrix block;
1420  this->get_block(0,0,block);
1421 
1422  // Set up preconditioner (i.e. lu-decompose the block)
1424 
1425  }
1426  {
1427 
1428  CRDoubleMatrix block;
1429  this->get_block(1,1,block);
1430 
1431  // Set up preconditioner (i.e. lu-decompose the block)
1433 
1434  } // end setup of last subsidiary preconditioner
1435 
1436 
1437  // next setup the off diagonal mat vec operators
1438  {
1439  // Get the block
1440  CRDoubleMatrix block_matrix = this->get_block(0,1);
1441 
1442  // Create matrix vector product
1443  Off_diagonal_matrix_vector_product_pt = new MatrixVectorProduct;
1444 
1445  // Set it up -- note that the block column index refers to the
1446  // block enumeration (not the dof enumeration)
1447  unsigned block_column_index=1;
1449  Off_diagonal_matrix_vector_product_pt,&block_matrix,block_column_index);
1450  }
1451 
1452  }
m m block(1, 0, 2, 2)<< 4
void get_block(const unsigned &i, const unsigned &j, MATRIX &output_matrix, const bool &ignore_replacement_block=false) const
Definition: block_preconditioner.h:673
unsigned ndof_types() const
Return the total number of DOF types.
Definition: block_preconditioner.h:1694
void setup_matrix_vector_product(MatrixVectorProduct *matvec_prod_pt, CRDoubleMatrix *block_pt, const Vector< unsigned > &block_col_indices)
Definition: block_preconditioner.h:2397
void set_nmesh(const unsigned &n)
Definition: block_preconditioner.h:2851
virtual void block_setup()
Definition: block_preconditioner.cc:2483
void set_mesh(const unsigned &i, const Mesh *const mesh_pt, const bool &allow_multiple_element_type_in_mesh=false)
Definition: block_preconditioner.h:2866
void setup(DoubleMatrixBase *matrix_pt)
Definition: preconditioner.h:94
Eigen::Matrix< Scalar, Dynamic, Dynamic, ColMajor > tmp
Definition: level3_impl.h:365
#define OOMPH_EXCEPTION_LOCATION
Definition: oomph_definitions.h:61
#define OOMPH_CURRENT_FUNCTION
Definition: oomph_definitions.h:86

References block(), OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION, and tmp.

◆ setup() [2/4]

template<typename MATRIX >
virtual void oomph::Preconditioner::setup
virtual

Setup the preconditioner. Pure virtual generic interface function.

Implements oomph::Preconditioner.

◆ setup() [3/4]

template<typename MATRIX >
void oomph::Preconditioner::setup
inlinevirtual

Compatability layer for old preconditioners where problem pointers were needed. The problem pointer is only used to get a communicator pointer.

Implements oomph::Preconditioner.

121  {
123  setup(matrix_pt);
124  }
MATRIX * matrix_pt() const
Definition: block_preconditioner.h:520
void setup()
Setup the preconditioner.
Definition: multi_poisson_block_preconditioners.h:1364
void obsolete()
Output warning message.
Definition: oomph_utilities.cc:1102

◆ setup() [4/4]

template<typename MATRIX >
void oomph::Preconditioner::setup
inlinevirtual

Setup the preconditioner: store the matrix pointer and the communicator pointer then call preconditioner specific setup() function.

Implements oomph::Preconditioner.

95  {
96  // Store matrix pointer
98 
99  // Extract and store communicator pointer
100  DistributableLinearAlgebraObject* dist_obj_pt =
102  if (dist_obj_pt != 0)
103  {
104  set_comm_pt(dist_obj_pt->distribution_pt()->communicator_pt());
105  }
106  else
107  {
108  set_comm_pt(0);
109  }
110 
111  double setup_time_start = TimingHelpers::timer();
112  setup();
113  double setup_time_finish = TimingHelpers::timer();
114  Setup_time = setup_time_finish - setup_time_start;
115  }
DistributableLinearAlgebraObject()
Default constructor - create a distribution.
Definition: linear_algebra_distribution.h:438
double Setup_time
The time it takes to set up this preconditioner.
Definition: preconditioner.h:243
virtual void set_comm_pt(const OomphCommunicator *const comm_pt)
Set the communicator pointer.
Definition: preconditioner.h:193
virtual void set_matrix_pt(DoubleMatrixBase *matrix_pt)
Set the matrix pointer.
Definition: preconditioner.h:165
double timer()
returns the time in seconds after some point in past
Definition: oomph_utilities.cc:1295

Member Data Documentation

◆ First_subsidiary_preconditioner_pt

template<typename MATRIX >
Preconditioner* oomph::TwoPlusThreeUpperTriangular< MATRIX >::First_subsidiary_preconditioner_pt
private

Pointer to preconditioners/inexact solver for (0,0) block

◆ Multi_poisson_mesh_pt

template<typename MATRIX >
Mesh* oomph::TwoPlusThreeUpperTriangular< MATRIX >::Multi_poisson_mesh_pt
private

Pointer to mesh with preconditionable elements used for classification of dof types.

Referenced by oomph::TwoPlusThreeUpperTriangular< MATRIX >::set_multi_poisson_mesh(), and oomph::TwoPlusThreeUpperTriangular< MATRIX >::TwoPlusThreeUpperTriangular().

◆ Off_diagonal_matrix_vector_product_pt

template<typename MATRIX >
MatrixVectorProduct* oomph::TwoPlusThreeUpperTriangular< MATRIX >::Off_diagonal_matrix_vector_product_pt
private

Pointer to matrix vector product operator for the single off diagonals.

◆ Second_subsidiary_preconditioner_pt

template<typename MATRIX >
Preconditioner* oomph::TwoPlusThreeUpperTriangular< MATRIX >::Second_subsidiary_preconditioner_pt
private

Pointer to preconditioners/inexact solver for (1,1) block


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