MatrixParameters.h

Go to the documentation of this file.

#ifndef included_AMP_MatrixParameters
#define included_AMP_MatrixParameters
 
#include "AMP/discretization/DOF_Manager.h"
#include "AMP/matrices/MatrixParametersBase.h"
#include "AMP/utils/AMP_MPI.h"
#include "AMP/vectors/Vector.h"
 
namespace AMP::LinearAlgebra {
 
 
class MatrixParameters : public MatrixParametersBase
{
public:
    MatrixParameters() = delete;
 
    explicit MatrixParameters( std::shared_ptr<AMP::Discretization::DOFManager> dofLeft,
                               std::shared_ptr<AMP::Discretization::DOFManager> dofRight,
                               const AMP_MPI &comm,
                               const std::function<std::vector<size_t>( size_t )> getRow = {} );
 
    explicit MatrixParameters( std::shared_ptr<AMP::Discretization::DOFManager> dofLeft,
                               std::shared_ptr<AMP::Discretization::DOFManager> dofRight,
                               const AMP_MPI &comm,
                               AMP::Utilities::Backend backend,
                               const std::function<std::vector<size_t>( size_t )> getRow = {} );
 
 
    explicit MatrixParameters( std::shared_ptr<AMP::Discretization::DOFManager> dofLeft,
                               std::shared_ptr<AMP::Discretization::DOFManager> dofRight,
                               const AMP_MPI &comm,
                               std::shared_ptr<Variable> varLeft,
                               std::shared_ptr<Variable> varRight,
                               const std::function<std::vector<size_t>( size_t )> getRow = {} );
 
    explicit MatrixParameters( std::shared_ptr<AMP::Discretization::DOFManager> dofLeft,
                               std::shared_ptr<AMP::Discretization::DOFManager> dofRight,
                               const AMP_MPI &comm,
                               std::shared_ptr<Variable> varLeft,
                               std::shared_ptr<Variable> varRight,
                               AMP::Utilities::Backend backend,
                               const std::function<std::vector<size_t>( size_t )> getRow = {} );
 
    explicit MatrixParameters( std::shared_ptr<AMP::Discretization::DOFManager> dofLeft,
                               std::shared_ptr<AMP::Discretization::DOFManager> dofRight,
                               const AMP_MPI &comm,
                               std::shared_ptr<CommunicationList> commListLeft,
                               std::shared_ptr<CommunicationList> commListRight,
                               const std::function<std::vector<size_t>( size_t )> getRow = {} );
 
    explicit MatrixParameters( std::shared_ptr<AMP::Discretization::DOFManager> dofLeft,
                               std::shared_ptr<AMP::Discretization::DOFManager> dofRight,
                               const AMP_MPI &comm,
                               std::shared_ptr<CommunicationList> commListLeft,
                               std::shared_ptr<CommunicationList> commListRight,
                               AMP::Utilities::Backend backend,
                               const std::function<std::vector<size_t>( size_t )> getRow = {} );
 
    explicit MatrixParameters( std::shared_ptr<AMP::Discretization::DOFManager> dofLeft,
                               std::shared_ptr<AMP::Discretization::DOFManager> dofRight,
                               const AMP_MPI &comm,
                               std::shared_ptr<Variable> varLeft,
                               std::shared_ptr<Variable> varRight,
                               std::shared_ptr<CommunicationList> commListLeft,
                               std::shared_ptr<CommunicationList> commListRight,
                               const std::function<std::vector<size_t>( size_t )> getRow = {} );
 
    explicit MatrixParameters( std::shared_ptr<AMP::Discretization::DOFManager> dofLeft,
                               std::shared_ptr<AMP::Discretization::DOFManager> dofRight,
                               const AMP_MPI &comm,
                               std::shared_ptr<Variable> varLeft,
                               std::shared_ptr<Variable> varRight,
                               std::shared_ptr<CommunicationList> commListLeft,
                               std::shared_ptr<CommunicationList> commListRight,
                               AMP::Utilities::Backend backend,
                               const std::function<std::vector<size_t>( size_t )> getRow = {} );
 
    virtual ~MatrixParameters() = default;
 
    size_t getLocalNumberOfRows() const;
 
    size_t getLocalNumberOfColumns() const;
 
    size_t getGlobalNumberOfRows() const;
 
    size_t getGlobalNumberOfColumns() const;
 
    const std::function<std::vector<size_t>( size_t )> &getRowFunction() const { return d_getRow; }
 
    std::shared_ptr<AMP::Discretization::DOFManager> getLeftDOFManager();
 
    std::shared_ptr<AMP::Discretization::DOFManager> getRightDOFManager();
 
    std::shared_ptr<CommunicationList> getLeftCommList();
 
    std::shared_ptr<CommunicationList> getRightCommList();
 
    std::string type() const override { return "MatrixParameters"; }
 
public: // Write/read restart data
    void registerChildObjects( AMP::IO::RestartManager *manager ) const override;
 
    void writeRestart( int64_t fid ) const override;
 
    MatrixParameters( int64_t fid, AMP::IO::RestartManager *manager );
 
protected:
    // Generate communication lists internally from the dof managers if not provided
    void generateCommLists();
 
    // The DOFManager for the left vector ( may be null )
    std::shared_ptr<AMP::Discretization::DOFManager> d_DOFManagerLeft;
 
    // The DOFManager for the right vector ( may be null )
    std::shared_ptr<AMP::Discretization::DOFManager> d_DOFManagerRight;
 
    std::shared_ptr<CommunicationList> d_CommListLeft;
 
    std::shared_ptr<CommunicationList> d_CommListRight;
 
    std::function<std::vector<size_t>( size_t )> d_getRow;
};
} // namespace AMP::LinearAlgebra
 
#endif