waves
Basic FE playground
katoptron::Algebraic< scalar > Class Template Reference

Class which is used to store Teuchos::RCP to the algebraic information of the problem: More...

#include <Algebraic.h>

Public Member Functions

 Algebraic (Teuchos::RCP< Map > map, Teuchos::RCP< Domain< scalar >> domain)
 Algebraic constructor. More...
 
Teuchos::RCP< Tpetra::Vector< scalar, local_ordinal_type, global_ordinal_type > > readVectorFromFile (std::string &name, size_t myRank)
 Function to read a vector from file and distribute it to the MPI processes. More...
 

Public Attributes

Teuchos::RCP< Mapmap
 
Teuchos::RCP< Graphgraph
 
Teuchos::RCP< Matrices< scalar > > matrices
 
Teuchos::RCP< Vectors< scalar > > vectors
 

Private Types

typedef Map::local_ordinal_type local_ordinal_type
 
typedef Map::global_ordinal_type global_ordinal_type
 

Detailed Description

template<typename scalar>
class katoptron::Algebraic< scalar >

Class which is used to store Teuchos::RCP to the algebraic information of the problem:

  • map: an object that stores all the maps,
  • graph: an object that stores all the graphs (the sparsity patterns of the matrices),
  • matrices: an object that stores all the matrices,
  • vectors: an object that stores all the vectors.

Member Typedef Documentation

◆ global_ordinal_type

template<typename scalar >
typedef Map::global_ordinal_type katoptron::Algebraic< scalar >::global_ordinal_type
private

◆ local_ordinal_type

template<typename scalar >
typedef Map::local_ordinal_type katoptron::Algebraic< scalar >::local_ordinal_type
private

Constructor & Destructor Documentation

◆ Algebraic()

template<typename scalar >
katoptron::Algebraic< scalar >::Algebraic ( Teuchos::RCP< Map _map,
Teuchos::RCP< Domain< scalar >>  domain 
)

Algebraic constructor.

This contrusctor calls the constructor of the katoptron::Graph, katoptron::Matrices, and katoptron::Vectors classes. To do so, we need information regarding the distributions of the nodes and elements over the MPI processes (information included in the katoptron::Map class) and information regarding the connectivity between the degrees of freedom (or, equivalently, between the nodes) (information included in katoptron::Domain::elementsList).

Arguments:

  • map: an RCP to a Map object,
  • domain: an RCP to a Domain object.

Member Function Documentation

◆ readVectorFromFile()

template<typename scalar >
Teuchos::RCP< Tpetra::Vector< scalar, Map::local_ordinal_type, Map::global_ordinal_type > > katoptron::Algebraic< scalar >::readVectorFromFile ( std::string &  name,
size_t  myRank 
)

Function to read a vector from file and distribute it to the MPI processes.

Arguments:

  • name: the name of input file,
  • myRank: rank of the process.

Member Data Documentation

◆ graph

template<typename scalar >
Teuchos::RCP<Graph> katoptron::Algebraic< scalar >::graph

◆ map

template<typename scalar >
Teuchos::RCP<Map> katoptron::Algebraic< scalar >::map

◆ matrices

template<typename scalar >
Teuchos::RCP<Matrices<scalar> > katoptron::Algebraic< scalar >::matrices

◆ vectors

template<typename scalar >
Teuchos::RCP<Vectors<scalar> > katoptron::Algebraic< scalar >::vectors

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