Inheritance diagram for SimpleFSIPreconditioner< MATRIX >:

Public Member Functions
	SimpleFSIPreconditioner (Problem *problem_pt)
	Constructor for SimpleFSIPreconditioner. More...

	~SimpleFSIPreconditioner ()
	Destructor: Clean up. More...

	SimpleFSIPreconditioner (const SimpleFSIPreconditioner &)
	Broken copy constructor. More...

void	set_navier_stokes_mesh (Mesh *mesh_pt)

void	set_solid_mesh (Mesh *mesh_pt)

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

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

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	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 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
NavierStokesSchurComplementPreconditioner *	Navier_stokes_preconditioner_pt
	Pointer the Navier Stokes preconditioner. More...

Preconditioner *	Solid_preconditioner_pt
	Pointer to the solid preconditioner. More...

MatrixVectorProduct *	Fluid_solid_coupling_matvec_pt
	Pointer to the fluid onto solid matrix vector product. More...

Mesh *	Navier_stokes_mesh_pt
	Pointer to the navier stokes mesh. More...

Mesh *	Solid_mesh_pt
	Pointer to the solid mesh. More...

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

Simple FSI preconditioner. A block uppper triangular preconditioner for the 2x2 FSI block system – DOFs are decomposed into fluid DOFs and solid DOFs. The fluid subisidiary system is solved with the Navier Stokes Preconditioner and the solid subsidiary system with the

Constructor & Destructor Documentation

◆ SimpleFSIPreconditioner() [1/2]

template<typename MATRIX >

SimpleFSIPreconditioner< MATRIX >::SimpleFSIPreconditioner ( Problem * problem_pt )

inline

Constructor for SimpleFSIPreconditioner.

   : BlockPreconditioner<MATRIX>(), Navier_stokes_preconditioner_pt(0),
     Solid_preconditioner_pt(0), Fluid_solid_coupling_matvec_pt(0),
     Navier_stokes_mesh_pt(0), Solid_mesh_pt(0)
   {
    // Create the Navier Stokes Schur Complement preconditioner
    Navier_stokes_preconditioner_pt = 
     new NavierStokesSchurComplementPreconditioner(problem_pt);
  
    // Create the Solid preconditioner
    Solid_preconditioner_pt = new SuperLUPreconditioner;
  
    // Create the matrix-vector product operator
    Fluid_solid_coupling_matvec_pt = new MatrixVectorProduct;
  
   }// end_of_constructor

References SimpleFSIPreconditioner< MATRIX >::Fluid_solid_coupling_matvec_pt, SimpleFSIPreconditioner< MATRIX >::Navier_stokes_preconditioner_pt, and SimpleFSIPreconditioner< MATRIX >::Solid_preconditioner_pt.

◆ ~SimpleFSIPreconditioner()

template<typename MATRIX >

SimpleFSIPreconditioner< MATRIX >::~SimpleFSIPreconditioner ( )

inline

Destructor: Clean up.

   {
    //Delete the Navier-Stokes preconditioner
    delete Navier_stokes_preconditioner_pt; Navier_stokes_preconditioner_pt = 0;
    
    //Delete the solid preconditioner
    delete Solid_preconditioner_pt; Solid_preconditioner_pt = 0;
    
    // Delete the matrix vector product operator
    delete Fluid_solid_coupling_matvec_pt; Fluid_solid_coupling_matvec_pt = 0;
   }

References SimpleFSIPreconditioner< MATRIX >::Fluid_solid_coupling_matvec_pt, SimpleFSIPreconditioner< MATRIX >::Navier_stokes_preconditioner_pt, and SimpleFSIPreconditioner< MATRIX >::Solid_preconditioner_pt.

◆ SimpleFSIPreconditioner() [2/2]

template<typename MATRIX >

SimpleFSIPreconditioner< MATRIX >::SimpleFSIPreconditioner ( const SimpleFSIPreconditioner< MATRIX > & )

inline

Broken copy constructor.

   {
    BrokenCopy::broken_copy("SimpleFSIPreconditioner");
   }

References oomph::BrokenCopy::broken_copy().

Member Function Documentation

◆ preconditioner_solve()

template<typename MATRIX >

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

virtual

Apply preconditioner to r.

Implements oomph::Preconditioner.

◆ set_navier_stokes_mesh()

template<typename MATRIX >

void SimpleFSIPreconditioner< MATRIX >::set_navier_stokes_mesh ( Mesh * mesh_pt )

inline

Access function to mesh containing the block-preconditionable Navier-Stokes elements.

   {
    Navier_stokes_mesh_pt = mesh_pt;
   }

References oomph::BlockPreconditioner< MATRIX >::mesh_pt(), and SimpleFSIPreconditioner< MATRIX >::Navier_stokes_mesh_pt.

◆ set_solid_mesh()

template<typename MATRIX >

void SimpleFSIPreconditioner< MATRIX >::set_solid_mesh ( Mesh * mesh_pt )

inline

Access function to mesh containing the block-preconditionable FSI solid elements.

   {
    Solid_mesh_pt = mesh_pt;
   }

References oomph::BlockPreconditioner< MATRIX >::mesh_pt(), and SimpleFSIPreconditioner< MATRIX >::Solid_mesh_pt.

◆ setup()

template<typename MATRIX >

void SimpleFSIPreconditioner< MATRIX >::setup ( )

virtual

Setup the preconditioner.

Implements oomph::Preconditioner.

Member Data Documentation

◆ Fluid_solid_coupling_matvec_pt

template<typename MATRIX >

MatrixVectorProduct* SimpleFSIPreconditioner< MATRIX >::Fluid_solid_coupling_matvec_pt

private

Pointer to the fluid onto solid matrix vector product.

Referenced by SimpleFSIPreconditioner< MATRIX >::SimpleFSIPreconditioner(), and SimpleFSIPreconditioner< MATRIX >::~SimpleFSIPreconditioner().

◆ Navier_stokes_mesh_pt

template<typename MATRIX >

Mesh* SimpleFSIPreconditioner< MATRIX >::Navier_stokes_mesh_pt

private

Pointer to the navier stokes mesh.

Referenced by SimpleFSIPreconditioner< MATRIX >::set_navier_stokes_mesh().

◆ Navier_stokes_preconditioner_pt

template<typename MATRIX >

NavierStokesSchurComplementPreconditioner* SimpleFSIPreconditioner< MATRIX >::Navier_stokes_preconditioner_pt

private

Pointer the Navier Stokes preconditioner.

Referenced by SimpleFSIPreconditioner< MATRIX >::SimpleFSIPreconditioner(), and SimpleFSIPreconditioner< MATRIX >::~SimpleFSIPreconditioner().

◆ Solid_mesh_pt

template<typename MATRIX >

Mesh* SimpleFSIPreconditioner< MATRIX >::Solid_mesh_pt

private

Pointer to the solid mesh.

Referenced by SimpleFSIPreconditioner< MATRIX >::set_solid_mesh().

◆ Solid_preconditioner_pt

template<typename MATRIX >

Preconditioner* SimpleFSIPreconditioner< MATRIX >::Solid_preconditioner_pt

private

Pointer to the solid preconditioner.

Referenced by SimpleFSIPreconditioner< MATRIX >::SimpleFSIPreconditioner(), and SimpleFSIPreconditioner< MATRIX >::~SimpleFSIPreconditioner().

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

mpi/solvers/fsi_channel_with_leaflet.cc

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<typename MATRIX> class SimpleFSIPreconditioner< MATRIX >

Constructor & Destructor Documentation

◆ SimpleFSIPreconditioner() [1/2]

◆ ~SimpleFSIPreconditioner()

◆ SimpleFSIPreconditioner() [2/2]

Member Function Documentation

◆ preconditioner_solve()

◆ set_navier_stokes_mesh()

◆ set_solid_mesh()

◆ setup()

Member Data Documentation

◆ Fluid_solid_coupling_matvec_pt

◆ Navier_stokes_mesh_pt

◆ Navier_stokes_preconditioner_pt

◆ Solid_mesh_pt

◆ Solid_preconditioner_pt

template<typename MATRIX>
class SimpleFSIPreconditioner< MATRIX >