52 #ifndef AMESOS2_SOLVERCORE_DECL_HPP
53 #define AMESOS2_SOLVERCORE_DECL_HPP
57 #include <Teuchos_RCP.hpp>
58 #include <Teuchos_ParameterList.hpp>
60 #include "Amesos2_Solver.hpp"
61 #include "Amesos2_MatrixTraits.hpp"
62 #include "Amesos2_MatrixAdapter_decl.hpp"
63 #include "Amesos2_MultiVecAdapter_decl.hpp"
102 template <
template <
class,
class>
class ConcreteSolver,
112 typedef ConcreteSolver<Matrix,Vector> solver_type;
113 typedef Matrix matrix_type;
114 typedef Vector vector_type;
135 Teuchos::RCP<Vector> X,
136 Teuchos::RCP<const Vector> B );
234 void solve()
override;
235 void solve(
const Teuchos::Ptr<Vector> X,
const Teuchos::Ptr<const Vector> B)
const override;
236 void solve(Vector* X,
const Vector* B)
const override;
238 int solve_ir(
const Teuchos::Ptr<Vector> X,
const Teuchos::Ptr<const Vector> B,
239 const int maxNumIters,
const bool verbose)
const;
240 int solve_ir(Vector* X,
const Vector* B,
241 const int maxNumIters,
const bool verbose)
const;
242 int solve_ir(
const int maxNumIters,
const bool verbose);
258 void setA(
const Teuchos::RCP<const Matrix> a,
EPhase keep_phase = CLEAN )
override;
260 void setA(
const Matrix* a,
EPhase keep_phase = CLEAN )
override {
setA(Teuchos::rcp(a), keep_phase); }
304 const Teuchos::RCP<Teuchos::ParameterList> & parameterList )
override;
341 return Teuchos::null;
352 return Teuchos::null;
363 Teuchos::RCP<const Teuchos::Comm<int> >
getComm()
const override
382 void describe(Teuchos::FancyOStream &out,
383 const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default)
const override;
403 Teuchos::FancyOStream &out,
404 const Teuchos::EVerbosityLevel verbLevel)
const override;
415 void getTiming(Teuchos::ParameterList& timingParameterList)
const override;
425 std::string
name()
const override;
455 Teuchos::RCP<const MatrixAdapter<Matrix> >
matrixA_;
516 #endif // AMESOS2_SOLVERCORE_DECL_HPP
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const override
Return a const parameter list of all of the valid parameters that this->setParameterList(...) will accept.
Definition: Amesos2_SolverCore_def.hpp:558
void setParameterList(const Teuchos::RCP< Teuchos::ParameterList > ¶meterList)
Set or update internal variables and solver options.
Definition: Amesos2_SolverCore_decl.hpp:328
void solve() override
Solves (or )
Definition: Amesos2_SolverCore_def.hpp:173
Amesos2::SolverCore: A templated interface for interaction with third-party direct sparse solvers...
Definition: Amesos2_SolverCore_decl.hpp:105
Vector * getXRaw() override
Returns a raw pointer to the LHS of the linear system.
Definition: Amesos2_SolverCore_decl.hpp:268
~SolverCore()
Destructor.
Definition: Amesos2_SolverCore_def.hpp:95
Holds internal status data about the owning Amesos2 solver.
Definition: Amesos2_Status.hpp:73
EPhase
Used to indicate a phase in the direct solution.
Definition: Amesos2_TypeDecl.hpp:65
global_size_type columnIndexBase_
Index base of column map of matrixA_.
Definition: Amesos2_SolverCore_decl.hpp:488
global_size_type globalNumCols_
Number of global columns in matrixA_.
Definition: Amesos2_SolverCore_decl.hpp:479
const Teuchos::RCP< const Vector > getB() override
Returns the vector that is the RHS of the linear system.
Definition: Amesos2_SolverCore_decl.hpp:274
super_type & setParameters(const Teuchos::RCP< Teuchos::ParameterList > ¶meterList) override
Set/update internal variables and solver options.
Definition: Amesos2_SolverCore_def.hpp:526
bool root_
If true, then this is the root processor.
Definition: Amesos2_SolverCore_decl.hpp:506
global_size_type globalNumRows_
Number of global rows in matrixA_.
Definition: Amesos2_SolverCore_decl.hpp:476
std::string description() const override
Returns a short description of this Solver.
Definition: Amesos2_SolverCore_def.hpp:596
void setA(const Teuchos::RCP< const Matrix > a, EPhase keep_phase=CLEAN) override
Sets the matrix A of this solver.
Definition: Amesos2_SolverCore_def.hpp:483
super_type & preOrdering() override
Pre-orders the matrix A for minimal fill-in.
Definition: Amesos2_SolverCore_def.hpp:103
Control control_
Parameters for solving.
Definition: Amesos2_SolverCore_decl.hpp:494
Teuchos::RCP< const Teuchos::Comm< int > > getComm() const override
Returns a pointer to the Teuchos::Comm communicator with this operator.
Definition: Amesos2_SolverCore_decl.hpp:363
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const override
Definition: Amesos2_SolverCore_def.hpp:606
void printTiming(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const override
Prints timing information about the current solver.
Definition: Amesos2_SolverCore_def.hpp:667
int nprocs_
Number of process images in the matrix communicator.
Definition: Amesos2_SolverCore_decl.hpp:509
SolverCore(Teuchos::RCP< const Matrix > A, Teuchos::RCP< Vector > X, Teuchos::RCP< const Vector > B)
Initialize a Solver instance.
Definition: Amesos2_SolverCore_def.hpp:70
void setA(const Matrix *a, EPhase keep_phase=CLEAN) override
Sets the matrix A of this solver.
Definition: Amesos2_SolverCore_decl.hpp:260
bool matrixShapeOK() override
Returns true if the solver can handle this matrix shape.
Definition: Amesos2_SolverCore_def.hpp:469
Container class for control variables.
super_type & operator=(const solver_type *rhs)
Do not allow copying of this Solver by assignment.
super_type & symbolicFactorization() override
Performs symbolic factorization on the matrix A.
Definition: Amesos2_SolverCore_def.hpp:123
Teuchos::RCP< Teuchos::ParameterList > unsetParameterList()
This is an empty stub.
Definition: Amesos2_SolverCore_decl.hpp:350
bool matrix_loaded_
Definition: Amesos2_SolverCore_decl.hpp:462
A Matrix adapter interface for Amesos2.
Definition: Amesos2_MatrixAdapter_decl.hpp:76
void setB(const Teuchos::RCP< const Vector > b) override
Sets the RHS vector B.
Definition: Amesos2_SolverCore_decl.hpp:270
void loadA(EPhase current_phase)
Refresh this solver's internal data about A.
Definition: Amesos2_SolverCore_def.hpp:767
std::string name() const override
Return the name of this solver.
Definition: Amesos2_SolverCore_def.hpp:759
Interface to Amesos2 solver objects.
Definition: Amesos2_Solver_decl.hpp:78
void setB(const Vector *b) override
Sets the RHS vector B using a raw pointer.
Definition: Amesos2_SolverCore_decl.hpp:272
void setX(Vector *x) override
Sets the LHS vector X using a raw pointer.
Definition: Amesos2_SolverCore_decl.hpp:264
void getTiming(Teuchos::ParameterList &timingParameterList) const override
Extracts timing information from the current solver.
Definition: Amesos2_SolverCore_def.hpp:749
const Vector * getBRaw() override
Returns a raw pointer to the RHS of the linear system.
Definition: Amesos2_SolverCore_decl.hpp:276
global_size_type globalNumNonZeros_
Number of global non-zero values in matrixA_.
Definition: Amesos2_SolverCore_decl.hpp:482
void setNnzLU(size_t nnz)
Set the number of non-zero values in the and factors.
Definition: Amesos2_SolverCore_decl.hpp:452
Enum and other types declarations for Amesos2.
void setX(const Teuchos::RCP< Vector > x) override
Sets the LHS vector X.
Definition: Amesos2_SolverCore_decl.hpp:262
int rank_
The MPI rank of this image.
Definition: Amesos2_SolverCore_decl.hpp:503
super_type & numericFactorization() override
Performs numeric factorization on the matrix A.
Definition: Amesos2_SolverCore_def.hpp:148
Teuchos::RCP< const Vector > multiVecB_
The RHS vector/multi-vector.
Definition: Amesos2_SolverCore_decl.hpp:473
Container class for Timers used with the Amesos2::Solver class.
Timers timers_
Various timing statistics.
Definition: Amesos2_SolverCore_decl.hpp:497
Teuchos::RCP< Teuchos::ParameterList > getNonconstParameterList()
This is a empty stub.
Definition: Amesos2_SolverCore_decl.hpp:339
size_t lu_nnz_
The number of non-zeros in the factors.
Definition: Amesos2_Status.hpp:149
Container class for status variables.
Teuchos::RCP< Vector > multiVecX_
The LHS vector/multi-vector.
Definition: Amesos2_SolverCore_decl.hpp:466
Teuchos::RCP< const MatrixAdapter< Matrix > > matrixA_
The LHS operator.
Definition: Amesos2_SolverCore_decl.hpp:455
global_size_type rowIndexBase_
Index base of rowmap of matrixA_.
Definition: Amesos2_SolverCore_decl.hpp:485
Status & getStatus() const override
Returns a reference to this solver's internal status object.
Definition: Amesos2_SolverCore_decl.hpp:370
const Teuchos::RCP< Vector > getX() override
Returns the vector that is the LHS of the linear system.
Definition: Amesos2_SolverCore_decl.hpp:266
Status status_
Holds status information about a solver.
Definition: Amesos2_SolverCore_decl.hpp:491