Loading...
Searching...
No Matches
strumpack::BLR::BLROptions< scalar_t > Class Template Reference

Class containing several options for the BLR code and data-structures. More...

#include <BLROptions.hpp>

Inheritance diagram for strumpack::BLR::BLROptions< scalar_t >:
Collaboration diagram for strumpack::BLR::BLROptions< scalar_t >:

Public Types

using real_t = typename RealType< scalar_t >::value_type
 

Public Member Functions

 BLROptions (const structured::StructuredOptions< scalar_t > &sopts)
 
void set_low_rank_algorithm (LowRankAlgorithm a)
 
void set_admissibility (Admissibility adm)
 
void set_BACA_blocksize (int B)
 
void set_BLR_factor_algorithm (BLRFactorAlgorithm a)
 
void set_compression_kernel (CompressionKernel a)
 
LowRankAlgorithm low_rank_algorithm () const
 
Admissibility admissibility () const
 
int BACA_blocksize () const
 
BLRFactorAlgorithm BLR_factor_algorithm () const
 
CompressionKernel compression_kernel () const
 
void set_from_command_line (int argc, const char *const *cargv) override
 
void describe_options () const override
 
- Public Member Functions inherited from strumpack::structured::StructuredOptions< scalar_t >
 StructuredOptions (Type type)
 
void set_rel_tol (real_t rel_tol)
 
void set_abs_tol (real_t abs_tol)
 
void set_leaf_size (int leaf_size)
 
void set_pivot_threshold (real_t thresh)
 
void set_max_rank (int max_rank)
 
void set_type (Type a)
 
void set_verbose (bool verbose)
 
real_t rel_tol () const
 
real_t abs_tol () const
 
real_t pivot_threshold () const
 
int leaf_size () const
 
int max_rank () const
 
Type type () const
 
bool verbose () const
 
bool use_gpu_aware_mpi () const
 

Detailed Description

template<typename scalar_t>
class strumpack::BLR::BLROptions< scalar_t >

Class containing several options for the BLR code and data-structures.

Template Parameters
scalar_tscalar type, can be float, double, std::complex<float> or std::complex<double>. This is used here mainly because tolerances might depend on the precision.

Member Typedef Documentation

◆ real_t

real_t is the real type corresponding to the (possibly complex) scalar_t template parameter

Member Function Documentation

◆ describe_options()

template<typename scalar_t >
void strumpack::BLR::BLROptions< scalar_t >::describe_options ( ) const
overridevirtual

◆ set_from_command_line()

template<typename scalar_t >
void strumpack::BLR::BLROptions< scalar_t >::set_from_command_line ( int  argc,
const char *const cargv 
)
overridevirtual

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