Opm::Helper::detail Namespace Reference

Functions

template<class SimulatorType , class LinalgObjectType , class Communicator >
void writeMatrixMarketObject (const SimulatorType &simulator, const LinalgObjectType &linalgObject, const std::string &objName, const Communicator *comm)
 

Function Documentation

◆ writeMatrixMarketObject()

template<class SimulatorType , class LinalgObjectType , class Communicator >
void Opm::Helper::detail::writeMatrixMarketObject ( const SimulatorType &  simulator,
const LinalgObjectType &  linalgObject,
const std::string &  objName,
const Communicator *  comm 
)

Output a linear algebra object to file in MatrixMarket format.

Common implementation function.

Template Parameters
SimulatorTypePackaged simulator type. Expected to provide, among other services, an episode index, a simulation time, and a physical model.
LinalgObjectTypeObject type for a linear algebra object. Expected to be a coefficient matrix type or a linear system vector type from the Dune ISTL.
CommunicatorISTL communication type. Typically
Dune::OwnerOverlapCopyCommunication<>
or similar.
Parameters
[in]simulatorSimulator object.
[in]linalgObjectLinear algebra object. Expected to be a Dune ISTL matrix or vector.
[in]objNameName of linear algebra object. Incorporated into the name of the MatrixMarket output file.
[in]commDune ISTL communication object. Unused in builds without MPI support. You may use a nullptr value in a sequential run of an MPI-enabled build to signify that parallel output is unneeded.

Referenced by Opm::Helper::writeMatrix(), and Opm::Helper::writeVector().