Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::AlephParams Class Reference

Parameters of a linear system. More...

#include <arcane/aleph/AlephParams.h>

Inheritance diagram for Arcane::AlephParams:
Collaboration diagram for Arcane::AlephParams:

Public Member Functions

 AlephParams (ITraceMng *, Real, Integer, Integer, Integer, Integer, Real, bool, bool, bool, bool, Real, bool, bool, bool, String, bool, Real, bool, Integer, Integer, Integer, Integer, Integer, TypesSolver::eAmgSmootherOption, TypesSolver::eAmgCoarseningOption, TypesSolver::eAmgCoarseSolverOption, bool, bool, TypesSolver::eCriteriaStop)
 AlephParams (ITraceMng *, Real, Integer, TypesSolver::ePreconditionerMethod, TypesSolver::eSolverMethod, Integer, Real, bool, bool, bool, bool, Real, bool, bool, bool, String, bool, Real, bool, Integer, Integer, Integer, Integer, Integer, TypesSolver::eAmgSmootherOption, TypesSolver::eAmgCoarseningOption, TypesSolver::eAmgCoarseSolverOption, bool, bool, TypesSolver::eCriteriaStop)
void setEpsilon (const Real epsilon)
void setMaxIter (const Integer max_iteration)
void setPrecond (const TypesSolver::ePreconditionerMethod preconditioner_method)
void setMethod (const TypesSolver::eSolverMethod solver_method)
void setAlpha (const Real alpha)
void setGamma (const Integer gamma)
void setXoUser (const bool xo_user)
void setCheckRealResidue (const bool check_real_residue)
void setPrintRealResidue (const bool print_real_residue)
void setDebugInfo (const bool debug_info)
void setMinRHSNorm (const Real min_rhs_norm)
void setConvergenceAnalyse (const bool convergence_analyse)
void setStopErrorStrategy (const bool stop_error_strategy)
void setWriteMatrixToFileErrorStrategy (const bool write_matrix_to_file_error_strategy)
void setWriteMatrixNameErrorStrategy (const String &write_matrix_name_error_strategy)
void setDDMCParameterListingOutput (const bool listing_output)
void setDDMCParameterAmgDiagonalThreshold (const Real threshold)
void setPrintCpuTimeResolution (const bool print_cpu_time_resolution)
void setAmgCoarseningMethod (const TypesSolver::eAmgCoarseningMethod method)
void setOutputLevel (const Integer output_level)
void setAmgCycle (const Integer amg_cycle)
void setAmgSolverIter (const Integer amg_solver_iterations)
void setAmgSmootherIter (const Integer amg_smoother_iterations)
void setAmgSmootherOption (const TypesSolver::eAmgSmootherOption amg_smootherOption)
void setAmgCoarseningOption (const TypesSolver::eAmgCoarseningOption amg_coarseningOption)
void setAmgCoarseSolverOption (const TypesSolver::eAmgCoarseSolverOption amg_coarseSolverOption)
void setKeepSolverStructure (const bool keep_solver_structure)
void setSequentialSolver (const bool sequential_solver)
void setCriteriaStop (const TypesSolver::eCriteriaStop criteria_stop)
Real epsilon () const
int maxIter () const
Real alpha () const
int gamma () const
TypesSolver::ePreconditionerMethod precond ()
TypesSolver::eSolverMethod method ()
bool xoUser () const
bool checkRealResidue () const
bool printRealResidue () const
bool debugInfo ()
Real minRHSNorm ()
bool convergenceAnalyse ()
bool stopErrorStrategy ()
bool writeMatrixToFileErrorStrategy ()
String writeMatrixNameErrorStrategy ()
bool DDMCParameterListingOutput () const
Real DDMCParameterAmgDiagonalThreshold () const
bool printCpuTimeResolution () const
int amgCoarseningMethod () const
int getOutputLevel () const
int getAmgCycle () const
int getAmgSolverIter () const
int getAmgSmootherIter () const
TypesSolver::eAmgSmootherOption getAmgSmootherOption () const
TypesSolver::eAmgCoarseningOption getAmgCoarseningOption () const
TypesSolver::eAmgCoarseSolverOption getAmgCoarseSolverOption () const
bool getKeepSolverStructure () const
bool getSequentialSolver () const
TypesSolver::eCriteriaStop getCriteriaStop () const
Public Member Functions inherited from Arcane::TraceAccessor
 TraceAccessor (ITraceMng *m)
 Constructs an accessor via the trace manager m.
 TraceAccessor (const TraceAccessor &rhs)
 Copy constructor.
TraceAccessoroperator= (const TraceAccessor &rhs)
 Copy assignment operator.
virtual ~TraceAccessor ()
 Frees resources.
ITraceMngtraceMng () const
 Trace manager.
TraceMessage info () const
 Flow for an information message.
TraceMessage pinfo () const
 Flow for a parallel information message.
TraceMessage info (char category) const
 Flow for an information message of a given category.
TraceMessage pinfo (char category) const
 Flow for a parallel information message of a given category.
TraceMessage info (bool v) const
 Flow for an information message.
TraceMessage warning () const
 Flow for a warning message.
TraceMessage pwarning () const
TraceMessage error () const
 Flow for an error message.
TraceMessage perror () const
TraceMessage log () const
 Flow for a log message.
TraceMessage plog () const
 Flow for a log message.
TraceMessage logdate () const
 Flow for a log message preceded by the date.
TraceMessage fatal () const
 Flow for a fatal error message.
TraceMessage pfatal () const
 Flow for a parallel fatal error message.
TraceMessageDbg debug (Trace::eDebugLevel=Trace::Medium) const
 Flow for a debug message.
Trace::eDebugLevel configDbgLevel () const
 Debug level of the configuration file.
TraceMessage info (Int32 verbose_level) const
 Flow for an information message of a given level.
TraceMessage linfo () const
 Flow for an information message with the local information level of this instance.
TraceMessage linfo (Int32 relative_level) const
 Flow for an information message with the local information level of this instance.
void fatalMessage (const StandaloneTraceMessage &o) const

Private Attributes

Real m_param_epsilon
Integer m_param_max_iteration
TypesSolver::ePreconditionerMethod m_param_preconditioner_method
TypesSolver::eSolverMethod m_param_solver_method
Integer m_param_gamma
Real m_param_alpha
bool m_param_xo_user
bool m_param_check_real_residue
bool m_param_print_real_residue
bool m_param_debug_info
Real m_param_min_rhs_norm
bool m_param_convergence_analyse
bool m_param_stop_error_strategy
bool m_param_write_matrix_to_file_error_strategy
String m_param_write_matrix_name_error_strategy
bool m_param_listing_output
Real m_param_threshold
bool m_param_print_cpu_time_resolution
Integer m_param_amg_coarsening_method
Integer m_param_output_level
Integer m_param_amg_cycle
Integer m_param_amg_solver_iterations
Integer m_param_amg_smoother_iterations
TypesSolver::eAmgSmootherOption m_param_amg_smootherOption
TypesSolver::eAmgCoarseningOption m_param_amg_coarseningOption
TypesSolver::eAmgCoarseSolverOption m_param_amg_coarseSolverOption
bool m_param_keep_solver_structure
bool m_param_sequential_solver
TypesSolver::eCriteriaStop m_param_criteria_stop

Additional Inherited Members

Protected Member Functions inherited from Arcane::TraceAccessor
void _setLocalVerboseLevel (Int32 v)
Int32 _localVerboseLevel () const

Detailed Description

Parameters of a linear system.

Definition at line 30 of file AlephParams.h.

Constructor & Destructor Documentation

◆ AlephParams() [1/2]

Arcane::AlephParams::AlephParams ( )

Definition at line 24 of file AlephParams.cc.

◆ AlephParams() [2/2]

Arcane::AlephParams::AlephParams ( ITraceMng * tm,
Real epsilon,
Integer max_iteration,
TypesSolver::ePreconditionerMethod preconditioner_method,
TypesSolver::eSolverMethod solver_method,
Integer gamma,
Real alpha,
bool xo_user,
bool check_real_residue,
bool print_real_residue,
bool debug_info,
Real min_rhs_norm,
bool convergence_analyse,
bool stop_error_strategy,
bool write_matrix_to_file_error_strategy,
String write_matrix_name_error_strategy,
bool listing_output,
Real threshold,
bool print_cpu_time_resolution,
Integer amg_coarsening_method,
Integer output_level,
Integer amg_cycle,
Integer amg_solver_iterations,
Integer amg_smoother_iterations,
TypesSolver::eAmgSmootherOption amg_smootherOption,
TypesSolver::eAmgCoarseningOption amg_coarseningOption,
TypesSolver::eAmgCoarseSolverOption amg_coarseSolverOption,
bool keep_solver_structure,
bool sequential_solver,
TypesSolver::eCriteriaStop param_criteria_stop )

Definition at line 60 of file AlephParams.cc.

◆ ~AlephParams()

Arcane::AlephParams::~AlephParams ( )

Definition at line 125 of file AlephParams.cc.

Member Function Documentation

◆ alpha()

Real Arcane::AlephParams::alpha ( ) const

Definition at line 299 of file AlephParams.cc.

◆ amgCoarseningMethod()

int Arcane::AlephParams::amgCoarseningMethod ( ) const

Definition at line 363 of file AlephParams.cc.

◆ checkRealResidue()

bool Arcane::AlephParams::checkRealResidue ( ) const

Definition at line 319 of file AlephParams.cc.

◆ convergenceAnalyse()

bool Arcane::AlephParams::convergenceAnalyse ( )

Definition at line 335 of file AlephParams.cc.

◆ DDMCParameterAmgDiagonalThreshold()

Real Arcane::AlephParams::DDMCParameterAmgDiagonalThreshold ( ) const

Definition at line 355 of file AlephParams.cc.

◆ DDMCParameterListingOutput()

bool Arcane::AlephParams::DDMCParameterListingOutput ( ) const

Definition at line 351 of file AlephParams.cc.

◆ debugInfo()

bool Arcane::AlephParams::debugInfo ( )

Definition at line 327 of file AlephParams.cc.

◆ epsilon()

Real Arcane::AlephParams::epsilon ( ) const

Definition at line 291 of file AlephParams.cc.

◆ gamma()

int Arcane::AlephParams::gamma ( ) const

Definition at line 303 of file AlephParams.cc.

◆ getAmgCoarseningOption()

TypesSolver::eAmgCoarseningOption Arcane::AlephParams::getAmgCoarseningOption ( ) const

Definition at line 387 of file AlephParams.cc.

◆ getAmgCoarseSolverOption()

TypesSolver::eAmgCoarseSolverOption Arcane::AlephParams::getAmgCoarseSolverOption ( ) const

Definition at line 391 of file AlephParams.cc.

◆ getAmgCycle()

int Arcane::AlephParams::getAmgCycle ( ) const

Definition at line 371 of file AlephParams.cc.

◆ getAmgSmootherIter()

int Arcane::AlephParams::getAmgSmootherIter ( ) const

Definition at line 379 of file AlephParams.cc.

◆ getAmgSmootherOption()

TypesSolver::eAmgSmootherOption Arcane::AlephParams::getAmgSmootherOption ( ) const

Definition at line 383 of file AlephParams.cc.

◆ getAmgSolverIter()

int Arcane::AlephParams::getAmgSolverIter ( ) const

Definition at line 375 of file AlephParams.cc.

◆ getCriteriaStop()

TypesSolver::eCriteriaStop Arcane::AlephParams::getCriteriaStop ( ) const

Definition at line 403 of file AlephParams.cc.

◆ getKeepSolverStructure()

bool Arcane::AlephParams::getKeepSolverStructure ( ) const

Definition at line 395 of file AlephParams.cc.

◆ getOutputLevel()

int Arcane::AlephParams::getOutputLevel ( ) const

Definition at line 367 of file AlephParams.cc.

◆ getSequentialSolver()

bool Arcane::AlephParams::getSequentialSolver ( ) const

Definition at line 399 of file AlephParams.cc.

◆ maxIter()

int Arcane::AlephParams::maxIter ( ) const

Definition at line 295 of file AlephParams.cc.

◆ method()

TypesSolver::eSolverMethod Arcane::AlephParams::method ( )

Definition at line 311 of file AlephParams.cc.

◆ minRHSNorm()

Real Arcane::AlephParams::minRHSNorm ( )

Definition at line 331 of file AlephParams.cc.

◆ precond()

TypesSolver::ePreconditionerMethod Arcane::AlephParams::precond ( )

Definition at line 307 of file AlephParams.cc.

◆ printCpuTimeResolution()

bool Arcane::AlephParams::printCpuTimeResolution ( ) const

Definition at line 359 of file AlephParams.cc.

◆ printRealResidue()

bool Arcane::AlephParams::printRealResidue ( ) const

Definition at line 323 of file AlephParams.cc.

◆ setAlpha()

void Arcane::AlephParams::setAlpha ( const Real alpha)

Definition at line 148 of file AlephParams.cc.

◆ setAmgCoarseningMethod()

void Arcane::AlephParams::setAmgCoarseningMethod ( const TypesSolver::eAmgCoarseningMethod method)

Definition at line 205 of file AlephParams.cc.

◆ setAmgCoarseningOption()

void Arcane::AlephParams::setAmgCoarseningOption ( const TypesSolver::eAmgCoarseningOption amg_coarseningOption)

Definition at line 269 of file AlephParams.cc.

◆ setAmgCoarseSolverOption()

void Arcane::AlephParams::setAmgCoarseSolverOption ( const TypesSolver::eAmgCoarseSolverOption amg_coarseSolverOption)

Definition at line 273 of file AlephParams.cc.

◆ setAmgCycle()

void Arcane::AlephParams::setAmgCycle ( const Integer amg_cycle)

Definition at line 253 of file AlephParams.cc.

◆ setAmgSmootherIter()

void Arcane::AlephParams::setAmgSmootherIter ( const Integer amg_smoother_iterations)

Definition at line 261 of file AlephParams.cc.

◆ setAmgSmootherOption()

void Arcane::AlephParams::setAmgSmootherOption ( const TypesSolver::eAmgSmootherOption amg_smootherOption)

Definition at line 265 of file AlephParams.cc.

◆ setAmgSolverIter()

void Arcane::AlephParams::setAmgSolverIter ( const Integer amg_solver_iterations)

Definition at line 257 of file AlephParams.cc.

◆ setCheckRealResidue()

void Arcane::AlephParams::setCheckRealResidue ( const bool check_real_residue)

Definition at line 160 of file AlephParams.cc.

◆ setConvergenceAnalyse()

void Arcane::AlephParams::setConvergenceAnalyse ( const bool convergence_analyse)

Definition at line 176 of file AlephParams.cc.

◆ setCriteriaStop()

void Arcane::AlephParams::setCriteriaStop ( const TypesSolver::eCriteriaStop criteria_stop)

Definition at line 285 of file AlephParams.cc.

◆ setDDMCParameterAmgDiagonalThreshold()

void Arcane::AlephParams::setDDMCParameterAmgDiagonalThreshold ( const Real threshold)

Definition at line 196 of file AlephParams.cc.

◆ setDDMCParameterListingOutput()

void Arcane::AlephParams::setDDMCParameterListingOutput ( const bool listing_output)

Definition at line 192 of file AlephParams.cc.

◆ setDebugInfo()

void Arcane::AlephParams::setDebugInfo ( const bool debug_info)

Definition at line 168 of file AlephParams.cc.

◆ setEpsilon()

void Arcane::AlephParams::setEpsilon ( const Real epsilon)

Definition at line 132 of file AlephParams.cc.

◆ setGamma()

void Arcane::AlephParams::setGamma ( const Integer gamma)

Definition at line 152 of file AlephParams.cc.

◆ setKeepSolverStructure()

void Arcane::AlephParams::setKeepSolverStructure ( const bool keep_solver_structure)

Definition at line 277 of file AlephParams.cc.

◆ setMaxIter()

void Arcane::AlephParams::setMaxIter ( const Integer max_iteration)

Definition at line 136 of file AlephParams.cc.

◆ setMethod()

void Arcane::AlephParams::setMethod ( const TypesSolver::eSolverMethod solver_method)

Definition at line 144 of file AlephParams.cc.

◆ setMinRHSNorm()

void Arcane::AlephParams::setMinRHSNorm ( const Real min_rhs_norm)

Definition at line 172 of file AlephParams.cc.

◆ setOutputLevel()

void Arcane::AlephParams::setOutputLevel ( const Integer output_level)

Definition at line 249 of file AlephParams.cc.

◆ setPrecond()

void Arcane::AlephParams::setPrecond ( const TypesSolver::ePreconditionerMethod preconditioner_method)

Definition at line 140 of file AlephParams.cc.

◆ setPrintCpuTimeResolution()

void Arcane::AlephParams::setPrintCpuTimeResolution ( const bool print_cpu_time_resolution)

Definition at line 200 of file AlephParams.cc.

◆ setPrintRealResidue()

void Arcane::AlephParams::setPrintRealResidue ( const bool print_real_residue)

Definition at line 164 of file AlephParams.cc.

◆ setSequentialSolver()

void Arcane::AlephParams::setSequentialSolver ( const bool sequential_solver)

Definition at line 281 of file AlephParams.cc.

◆ setStopErrorStrategy()

void Arcane::AlephParams::setStopErrorStrategy ( const bool stop_error_strategy)

Definition at line 180 of file AlephParams.cc.

◆ setWriteMatrixNameErrorStrategy()

void Arcane::AlephParams::setWriteMatrixNameErrorStrategy ( const String & write_matrix_name_error_strategy)

Definition at line 188 of file AlephParams.cc.

◆ setWriteMatrixToFileErrorStrategy()

void Arcane::AlephParams::setWriteMatrixToFileErrorStrategy ( const bool write_matrix_to_file_error_strategy)

Definition at line 184 of file AlephParams.cc.

◆ setXoUser()

void Arcane::AlephParams::setXoUser ( const bool xo_user)

Definition at line 156 of file AlephParams.cc.

◆ stopErrorStrategy()

bool Arcane::AlephParams::stopErrorStrategy ( )

Definition at line 339 of file AlephParams.cc.

◆ writeMatrixNameErrorStrategy()

String Arcane::AlephParams::writeMatrixNameErrorStrategy ( )

Definition at line 347 of file AlephParams.cc.

◆ writeMatrixToFileErrorStrategy()

bool Arcane::AlephParams::writeMatrixToFileErrorStrategy ( )

Definition at line 343 of file AlephParams.cc.

◆ xoUser()

bool Arcane::AlephParams::xoUser ( ) const

Definition at line 315 of file AlephParams.cc.

Member Data Documentation

◆ m_param_alpha

Real Arcane::AlephParams::m_param_alpha
private

Definition at line 127 of file AlephParams.h.

◆ m_param_amg_coarsening_method

Integer Arcane::AlephParams::m_param_amg_coarsening_method
private

Definition at line 140 of file AlephParams.h.

◆ m_param_amg_coarseningOption

TypesSolver::eAmgCoarseningOption Arcane::AlephParams::m_param_amg_coarseningOption
private

Definition at line 146 of file AlephParams.h.

◆ m_param_amg_coarseSolverOption

TypesSolver::eAmgCoarseSolverOption Arcane::AlephParams::m_param_amg_coarseSolverOption
private

Definition at line 147 of file AlephParams.h.

◆ m_param_amg_cycle

Integer Arcane::AlephParams::m_param_amg_cycle
private

Definition at line 142 of file AlephParams.h.

◆ m_param_amg_smoother_iterations

Integer Arcane::AlephParams::m_param_amg_smoother_iterations
private

Definition at line 144 of file AlephParams.h.

◆ m_param_amg_smootherOption

TypesSolver::eAmgSmootherOption Arcane::AlephParams::m_param_amg_smootherOption
private

Definition at line 145 of file AlephParams.h.

◆ m_param_amg_solver_iterations

Integer Arcane::AlephParams::m_param_amg_solver_iterations
private

Definition at line 143 of file AlephParams.h.

◆ m_param_check_real_residue

bool Arcane::AlephParams::m_param_check_real_residue
private

Definition at line 129 of file AlephParams.h.

◆ m_param_convergence_analyse

bool Arcane::AlephParams::m_param_convergence_analyse
private

Definition at line 133 of file AlephParams.h.

◆ m_param_criteria_stop

TypesSolver::eCriteriaStop Arcane::AlephParams::m_param_criteria_stop
private

Definition at line 150 of file AlephParams.h.

◆ m_param_debug_info

bool Arcane::AlephParams::m_param_debug_info
private

Definition at line 131 of file AlephParams.h.

◆ m_param_epsilon

Real Arcane::AlephParams::m_param_epsilon
private

Definition at line 122 of file AlephParams.h.

◆ m_param_gamma

Integer Arcane::AlephParams::m_param_gamma
private

Definition at line 126 of file AlephParams.h.

◆ m_param_keep_solver_structure

bool Arcane::AlephParams::m_param_keep_solver_structure
private

Definition at line 148 of file AlephParams.h.

◆ m_param_listing_output

bool Arcane::AlephParams::m_param_listing_output
private

Definition at line 137 of file AlephParams.h.

◆ m_param_max_iteration

Integer Arcane::AlephParams::m_param_max_iteration
private

Definition at line 123 of file AlephParams.h.

◆ m_param_min_rhs_norm

Real Arcane::AlephParams::m_param_min_rhs_norm
private

Definition at line 132 of file AlephParams.h.

◆ m_param_output_level

Integer Arcane::AlephParams::m_param_output_level
private

Definition at line 141 of file AlephParams.h.

◆ m_param_preconditioner_method

TypesSolver::ePreconditionerMethod Arcane::AlephParams::m_param_preconditioner_method
private

Definition at line 124 of file AlephParams.h.

◆ m_param_print_cpu_time_resolution

bool Arcane::AlephParams::m_param_print_cpu_time_resolution
private

Definition at line 139 of file AlephParams.h.

◆ m_param_print_real_residue

bool Arcane::AlephParams::m_param_print_real_residue
private

Definition at line 130 of file AlephParams.h.

◆ m_param_sequential_solver

bool Arcane::AlephParams::m_param_sequential_solver
private

Definition at line 149 of file AlephParams.h.

◆ m_param_solver_method

TypesSolver::eSolverMethod Arcane::AlephParams::m_param_solver_method
private

Definition at line 125 of file AlephParams.h.

◆ m_param_stop_error_strategy

bool Arcane::AlephParams::m_param_stop_error_strategy
private

Definition at line 134 of file AlephParams.h.

◆ m_param_threshold

Real Arcane::AlephParams::m_param_threshold
private

Definition at line 138 of file AlephParams.h.

◆ m_param_write_matrix_name_error_strategy

String Arcane::AlephParams::m_param_write_matrix_name_error_strategy
private

Definition at line 136 of file AlephParams.h.

◆ m_param_write_matrix_to_file_error_strategy

bool Arcane::AlephParams::m_param_write_matrix_to_file_error_strategy
private

Definition at line 135 of file AlephParams.h.

◆ m_param_xo_user

bool Arcane::AlephParams::m_param_xo_user
private

Definition at line 128 of file AlephParams.h.


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