DOLFIN
DOLFIN C++ interface
Loading...
Searching...
No Matches
dolfin::SUNDIALSNVector Class Reference

#include <SUNDIALSNVector.h>

Public Member Functions

 SUNDIALSNVector (MPI_Comm comm=MPI_COMM_WORLD)
 
 SUNDIALSNVector (MPI_Comm comm, std::size_t N)
 
 SUNDIALSNVector (const SUNDIALSNVector &x)
 
 SUNDIALSNVector (const GenericVector &x)
 
 SUNDIALSNVector (std::shared_ptr< GenericVector > x)
 
N_Vector nvector () const
 
std::shared_ptr< GenericVectorvec () const
 
const SUNDIALSNVectoroperator= (const SUNDIALSNVector &x)
 Assignment operator.
 

Detailed Description

Interface to SUNDIALS NVector

Constructor & Destructor Documentation

◆ SUNDIALSNVector() [1/5]

dolfin::SUNDIALSNVector::SUNDIALSNVector ( MPI_Comm comm = MPI_COMM_WORLD)
inline

Create empty vector

Parameters
commMPI communicator

◆ SUNDIALSNVector() [2/5]

dolfin::SUNDIALSNVector::SUNDIALSNVector ( MPI_Comm comm,
std::size_t N )
inline

Create vector of size N

Parameters
commMPI communicator
NSize of vector

◆ SUNDIALSNVector() [3/5]

dolfin::SUNDIALSNVector::SUNDIALSNVector ( const SUNDIALSNVector & x)
inline

Copy constructor

Parameters
xSUNDIALSNVector to copy

◆ SUNDIALSNVector() [4/5]

dolfin::SUNDIALSNVector::SUNDIALSNVector ( const GenericVector & x)
inline

Create an SUNDIALSNVector from a GenericVector

Parameters
xGenericVector to copy

◆ SUNDIALSNVector() [5/5]

dolfin::SUNDIALSNVector::SUNDIALSNVector ( std::shared_ptr< GenericVector > x)
inline

Create a SUNDIALSNVector wrapper to an existing GenericVector

Parameters
xGenericVector pointer to copy

Member Function Documentation

◆ nvector()

N_Vector dolfin::SUNDIALSNVector::nvector ( ) const
inline

Get underlying raw SUNDIALS N_Vector struct

Returns
raw SUNDIALS N_Vector struct

◆ vec()

std::shared_ptr< GenericVector > dolfin::SUNDIALSNVector::vec ( ) const
inline

Get underlying GenericVector

Returns
underlying GenericVector

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