#include <general_purpose_space_time_block_preconditioner.h>

Inheritance diagram for oomph::ExactDGPBlockPreconditioner< MATRIX >:

Public Member Functions
	ExactDGPBlockPreconditioner ()
	Constructor. (By default this preconditioner is upper triangular). More...

virtual	~ExactDGPBlockPreconditioner ()
	Destructor - delete the preconditioner matrices. More...

virtual void	clean_up_memory ()
	Clean up the memory. More...

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

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

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

void	setup ()
	Setup the preconditioner. More...

void	enable_doc_memory_usage ()
	Document the memory usage. More...

void	disable_doc_memory_usage ()
	Don't document the memory usage! More...

double	get_memory_usage_in_bytes ()
	Get the memory statistics. More...

Public Member Functions inherited from oomph::GeneralPurposeBlockPreconditioner< MATRIX >
	GeneralPurposeBlockPreconditioner ()
	constructor More...

virtual	~GeneralPurposeBlockPreconditioner ()

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

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

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

void	reset_subsidiary_preconditioner_function_to_default ()
	Reset the subsidiary preconditioner function to its default. More...

void	set_subsidiary_preconditioner_pt (Preconditioner *prec, const unsigned &i)

Preconditioner *	subsidiary_preconditioner_pt (const unsigned &i) const

void	set_dof_to_block_map (Vector< unsigned > &dof_to_block_map)
	Specify a DOF to block map. More...

void	add_mesh (const Mesh *mesh_pt, const bool &allow_multiple_element_type_in_mesh=false)

unsigned	gp_nmesh ()

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 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< 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< 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, MATRIX &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 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	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 Attributes
bool	Preconditioner_has_been_setup

bool	Compute_memory_statistics

double	Memory_usage_in_bytes

Additional Inherited Members
Public Types inherited from oomph::GeneralPurposeBlockPreconditioner< MATRIX >
typedef Preconditioner (	SubsidiaryPreconditionerFctPt) ()

Protected Member Functions inherited from oomph::GeneralPurposeBlockPreconditioner< MATRIX >
void	gp_preconditioner_set_all_meshes ()
	Set the mesh in the block preconditioning framework. More...

void	gp_preconditioner_block_setup ()
	Modified block setup for general purpose block preconditioners. More...

void	fill_in_subsidiary_preconditioners (const unsigned &nprec_needed)

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 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::GeneralPurposeBlockPreconditioner< MATRIX >
Vector< Preconditioner * >	Subsidiary_preconditioner_pt
	List of preconditioners to use for the blocks to be solved. More...

SubsidiaryPreconditionerFctPt	Subsidiary_preconditioner_creation_function_pt

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< 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

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

General purpose block tridiagonal preconditioner. By default SuperLUPreconditioner (or SuperLUDistPreconditioner) is used to solve the subsidiary systems, but other preconditioners can be used by setting them using passing a pointer to a function of type SubsidiaryPreconditionerFctPt to the method subsidiary_preconditioner_function_pt().

Constructor & Destructor Documentation

◆ ExactDGPBlockPreconditioner() [1/2]

template<typename MATRIX >

oomph::ExactDGPBlockPreconditioner< MATRIX >::ExactDGPBlockPreconditioner ( )

inline

Constructor. (By default this preconditioner is upper triangular).

                                   : GeneralPurposeBlockPreconditioner<MATRIX>()
     {
       // The preconditioner has been created but it hasn't been set up yet
       Preconditioner_has_been_setup = false;
  
       // By default, don't store the memory statistics of this preconditioner
       Compute_memory_statistics = false;
  
       // Initialise the value of Memory_usage_in_bytes
       Memory_usage_in_bytes = 0.0;
     } // End of ExactDGPBlockPreconditioner

References oomph::ExactDGPBlockPreconditioner< MATRIX >::Compute_memory_statistics, oomph::ExactDGPBlockPreconditioner< MATRIX >::Memory_usage_in_bytes, and oomph::ExactDGPBlockPreconditioner< MATRIX >::Preconditioner_has_been_setup.

◆ ~ExactDGPBlockPreconditioner()

template<typename MATRIX >

virtual oomph::ExactDGPBlockPreconditioner< MATRIX >::~ExactDGPBlockPreconditioner ( )

inlinevirtual

Destructor - delete the preconditioner matrices.

     {
       // Forward the call to a helper clean-up function
       this->clean_up_memory();
     } // End of ~ExactDGPBlockPreconditioner

References oomph::ExactDGPBlockPreconditioner< MATRIX >::clean_up_memory().

◆ ExactDGPBlockPreconditioner() [2/2]

template<typename MATRIX >

oomph::ExactDGPBlockPreconditioner< MATRIX >::ExactDGPBlockPreconditioner ( const ExactDGPBlockPreconditioner< MATRIX > & )

delete

Broken copy constructor.

Member Function Documentation

◆ clean_up_memory()

template<typename MATRIX >

virtual void oomph::ExactDGPBlockPreconditioner< MATRIX >::clean_up_memory ( )

inlinevirtual

Clean up the memory.

Reimplemented from oomph::GeneralPurposeBlockPreconditioner< MATRIX >.

     {
       // Clean up the base class too
       GeneralPurposeBlockPreconditioner<MATRIX>::clean_up_memory();
     } // End of clean_up_memory

References oomph::GeneralPurposeBlockPreconditioner< MATRIX >::clean_up_memory().

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

◆ disable_doc_memory_usage()

template<typename MATRIX >

void oomph::ExactDGPBlockPreconditioner< MATRIX >::disable_doc_memory_usage ( )

inline

Don't document the memory usage!

Set the appropriate flag to false

     {
       Compute_memory_statistics = false;
     } // End of disable_doc_memory_usage

References oomph::ExactDGPBlockPreconditioner< MATRIX >::Compute_memory_statistics.

◆ enable_doc_memory_usage()

template<typename MATRIX >

void oomph::ExactDGPBlockPreconditioner< MATRIX >::enable_doc_memory_usage ( )

inline

Document the memory usage.

Set the appropriate flag to true

     {
       Compute_memory_statistics = true;
     } // End of enable_doc_memory_usage

References oomph::ExactDGPBlockPreconditioner< MATRIX >::Compute_memory_statistics.

◆ get_memory_usage_in_bytes()

template<typename MATRIX >

double oomph::ExactDGPBlockPreconditioner< MATRIX >::get_memory_usage_in_bytes ( )

inline

Get the memory statistics.

     {
       // Has the preconditioner even been set up yet?
       if (Preconditioner_has_been_setup)
       {
         // Were we meant to compute the statistics?
         if (Compute_memory_statistics)
         {
           // Return the appropriate variable value
           return Memory_usage_in_bytes;
         }
         else
         {
           // Allocate storage for an output stream
           std::ostringstream warning_message_stream;
  
           // Create a warning message
           warning_message_stream
             << "The memory statistics have not been calculated "
             << "so I'm returning\nthe value zero." << std::endl;
  
           // Give the user a warning
           OomphLibWarning(warning_message_stream.str(),
                           OOMPH_CURRENT_FUNCTION,
                           OOMPH_EXCEPTION_LOCATION);
  
           // Return the value zero
           return 0.0;
         }
       }
       // If the preconditioner hasn't been set up yet
       else
       {
         // Allocate storage for an output stream
         std::ostringstream warning_message_stream;
  
         // Create a warning message
         warning_message_stream
           << "The preconditioner hasn't even been set up yet "
           << "so I'm returning\nthe value zero." << std::endl;
  
         // Give the user a warning
         OomphLibWarning(warning_message_stream.str(),
                         OOMPH_CURRENT_FUNCTION,
                         OOMPH_EXCEPTION_LOCATION);
  
         // Return the value zero
         return 0.0;
       } // if (Preconditioner_has_been_setup)
     } // End of get_memory_usage_in_bytes

References oomph::ExactDGPBlockPreconditioner< MATRIX >::Compute_memory_statistics, oomph::ExactDGPBlockPreconditioner< MATRIX >::Memory_usage_in_bytes, OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION, and oomph::ExactDGPBlockPreconditioner< MATRIX >::Preconditioner_has_been_setup.

◆ operator=()

template<typename MATRIX >

void oomph::ExactDGPBlockPreconditioner< MATRIX >::operator= ( const ExactDGPBlockPreconditioner< MATRIX > & )

delete

Broken assignment operator.

◆ preconditioner_solve()

template<typename MATRIX >

void oomph::ExactDGPBlockPreconditioner< MATRIX >::preconditioner_solve	(	const DoubleVector &	r,
		DoubleVector &	z
	)

virtual

Apply preconditioner to r.

Preconditioner solve for the exact preconditioner.

Implements oomph::Preconditioner.

   {
     // Vector of vectors for each section of residual vector
     Vector<DoubleVector> block_r;
  
     // Rearrange the vector r into the vector of block vectors block_r
     this->get_block_vectors(r, block_r);
  
     // Allocate space for the properly rearranged RHS vector
     DoubleVector rhs_reordered;
  
     // Concatenate the DoubleVectors together
     DoubleVectorHelpers::concatenate(block_r, rhs_reordered);
  
     // Allocate space for the rearranged solution vector
     DoubleVector z_reordered;
  
     // Solve the whole system exactly
     this->Subsidiary_preconditioner_pt[0]->preconditioner_solve(rhs_reordered,
                                                                 z_reordered);
  
     // Vector of vectors for each section of solution vector (copy the RHS
     // block vector to get the sizing and distributions right)
     Vector<DoubleVector> block_z(block_r);
  
     // Split the solution vector into blocks
     DoubleVectorHelpers::split(z_reordered, block_z);
  
     // Copy the solution from the block vector block_z back into z
     this->return_block_vectors(block_z, z);
   } // End of preconditioner_solve

References oomph::DoubleVectorHelpers::concatenate(), UniformPSDSelfTest::r, and oomph::DoubleVectorHelpers::split().

◆ setup()

template<typename MATRIX >

void oomph::ExactDGPBlockPreconditioner< MATRIX >::setup

virtual

Setup the preconditioner.

Set up the exact preconditioner.

Implements oomph::Preconditioner.

   {
     // Clean the memory
     this->clean_up_memory();
  
     // Subsidiary preconditioners don't really need the meshes
     if (this->is_master_block_preconditioner())
     {
 #ifdef PARANOID
       if (this->gp_nmesh() == 0)
       {
         std::ostringstream err_msg;
         err_msg << "There are no meshes set.\n"
                 << "Did you remember to call add_mesh(...)?";
         throw OomphLibError(
           err_msg.str(), OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION);
       }
 #endif
  
       // Set all meshes if this is master block preconditioner
       this->gp_preconditioner_set_all_meshes();
     }
  
     // Initialise the memory usage variable
     Memory_usage_in_bytes = 0.0;
  
     // If we're meant to build silently
     if (this->Silent_preconditioner_setup == true)
     {
       // Store the output stream pointer
       this->Stream_pt = oomph_info.stream_pt();
  
       // Now set the oomph_info stream pointer to the null stream to
       // disable all possible output
       oomph_info.stream_pt() = &oomph_nullstream;
     }
  
     // Set up the block look up schemes
     this->gp_preconditioner_block_setup();
  
     // Number of block types
     unsigned n_block_types = this->nblock_types();
  
     // Fill in any null subsidiary preconditioners
     this->fill_in_subsidiary_preconditioners(n_block_types);
  
     // The total time for setting up the subsidiary preconditioners
     double t_subsidiary_setup_total = 0.0;
  
     // Stores the blocks we want to extract
     VectorMatrix<BlockSelector> required_blocks(n_block_types, n_block_types);
  
     // Boolean indicating if we want the block, stored for readability.
     const bool want_block = true;
  
     // Loop over the block rows
     for (unsigned i = 0; i < n_block_types; i++)
     {
       // Loop over the block columns
       for (unsigned j = 0; j < n_block_types; j++)
       {
         // Indicate that we want this block
         required_blocks[i][j].select_block(i, j, want_block);
       }
     } // for (unsigned i=0;i<n_block_types;i++)
  
     // Get the start time
     double t_extract_start = TimingHelpers::timer();
  
     // Get the concatenated blocks
     CRDoubleMatrix full_matrix = this->get_concatenated_block(required_blocks);
  
     // The total time for extracting all the blocks from the "global" matrix
     double t_extraction_total = (TimingHelpers::timer() - t_extract_start);
  
     // Get the start time
     double t_subsidiary_setup_start = TimingHelpers::timer();
  
     // It's a block preconditioner so pass it a pointer to the global matrix!
     this->Subsidiary_preconditioner_pt[0]->setup(&full_matrix);
  
     // Update the timing total
     t_subsidiary_setup_total +=
       (TimingHelpers::timer() - t_subsidiary_setup_start);
  
     // Remember that the preconditioner has been set up
     Preconditioner_has_been_setup = true;
  
     // If we're meant to build silently, reassign the oomph stream pointer
     if (this->Silent_preconditioner_setup == true)
     {
       // Store the output stream pointer
       oomph_info.stream_pt() = this->Stream_pt;
  
       // Reset our own stream pointer
       this->Stream_pt = 0;
     }
  
     // Tell the user
     oomph_info << "Total block extraction time [sec]: " << t_extraction_total
                << "\nTotal subsidiary preconditioner setup time [sec]: "
                << t_subsidiary_setup_total << std::endl;
  
     // Do we need to doc. the memory statistics?
     // NOTE: We're going to assume that either:
     //    (1) GMRES is used as a subsidiary block preconditioner (preconditioned
     //        by the Navier-Stokes subsidiary block preconditioner), or;
     //    (2) SuperLU is used as the subsidiary preconditioner.
     if (Compute_memory_statistics)
     {
       // How many rows are there in the global Jacobian?
       unsigned n_row = this->matrix_pt()->nrow();
  
       // How many nonzeros are there in the global Jacobian?
       unsigned n_nnz = this->matrix_pt()->nnz();
  
       // Add in the subsidiary preconditioners contribution
       double total_memory_usage_for_setup_phase =
         dynamic_cast<SuperLUPreconditioner*>(
           this->Subsidiary_preconditioner_pt[0])
           ->get_total_memory_needed_for_superlu();
  
       // Add in the global Jacobian contribution
       total_memory_usage_for_setup_phase +=
         ((2 * ((n_row + 1) * sizeof(int))) +
          (n_nnz * (sizeof(int) + sizeof(double))));
  
       // How much memory have we used in the subsidiary preconditioners?
       oomph_info << "\nTotal amount of memory being used after setup (MB): "
                  << total_memory_usage_for_setup_phase / 1.0e+06 << "\n"
                  << std::endl;
     } // if (Compute_memory_statistics)
   } // End of setup

References oomph::TerminateHelper::clean_up_memory(), i, int(), j, OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION, oomph::oomph_info, oomph::oomph_nullstream, GlobalParameters::Stream_pt, oomph::OomphInfo::stream_pt(), and oomph::TimingHelpers::timer().

Member Data Documentation

◆ Compute_memory_statistics

template<typename MATRIX >

bool oomph::ExactDGPBlockPreconditioner< MATRIX >::Compute_memory_statistics

private

Flag to indicate whether or not to record the memory statistics this preconditioner

Referenced by oomph::ExactDGPBlockPreconditioner< MATRIX >::disable_doc_memory_usage(), oomph::ExactDGPBlockPreconditioner< MATRIX >::enable_doc_memory_usage(), oomph::ExactDGPBlockPreconditioner< MATRIX >::ExactDGPBlockPreconditioner(), and oomph::ExactDGPBlockPreconditioner< MATRIX >::get_memory_usage_in_bytes().

◆ Memory_usage_in_bytes

template<typename MATRIX >

double oomph::ExactDGPBlockPreconditioner< MATRIX >::Memory_usage_in_bytes

private

Storage for the memory usage of the solver if the flag above is set to true (in bytes)

Referenced by oomph::ExactDGPBlockPreconditioner< MATRIX >::ExactDGPBlockPreconditioner(), and oomph::ExactDGPBlockPreconditioner< MATRIX >::get_memory_usage_in_bytes().

◆ Preconditioner_has_been_setup

template<typename MATRIX >

bool oomph::ExactDGPBlockPreconditioner< MATRIX >::Preconditioner_has_been_setup

private

Control flag is true if the preconditioner has been setup (used so we can wipe the data when the preconditioner is called again)

Referenced by oomph::ExactDGPBlockPreconditioner< MATRIX >::ExactDGPBlockPreconditioner(), and oomph::ExactDGPBlockPreconditioner< MATRIX >::get_memory_usage_in_bytes().

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ ExactDGPBlockPreconditioner() [1/2]

◆ ~ExactDGPBlockPreconditioner()

◆ ExactDGPBlockPreconditioner() [2/2]

Member Function Documentation

◆ clean_up_memory()

◆ disable_doc_memory_usage()

◆ enable_doc_memory_usage()

◆ get_memory_usage_in_bytes()

◆ operator=()

◆ preconditioner_solve()

◆ setup()

Member Data Documentation

◆ Compute_memory_statistics

◆ Memory_usage_in_bytes

◆ Preconditioner_has_been_setup

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