MathLib::LisVector Class Reference

Detailed Description

Lis vector wrapper class.

Definition at line 19 of file LisVector.h.

#include <LisVector.h>

Public Types
using	IndexType = LIS_INT

Public Member Functions
	LisVector (std::size_t length)
	LisVector (std::size_t length, double *data)
	LisVector (LisVector const &src)
	copy constructor
virtual	~LisVector ()
std::size_t	size () const
	return a vector length
std::size_t	getRangeBegin () const
	return a start index of the active data range
std::size_t	getRangeEnd () const
	return an end index of the active data range
void	setZero ()
double	operator[] (IndexType rowId) const
	access entry
double	get (IndexType rowId) const
	get entry
void	set (IndexType rowId, double v)
	set entry
void	add (IndexType rowId, double v)
	add entry
void	write (const std::string &filename) const
	printout this equation for debugging
LIS_VECTOR &	getRawVector ()
	return a raw Lis vector object
template<class T_SUBVEC>
void	set (const std::vector< IndexType > &pos, const T_SUBVEC &sub_vec)
	set entries
template<class T_SUBVEC>
void	add (const std::vector< IndexType > &pos, const T_SUBVEC &sub_vec)
	add entries
void	copyValues (std::vector< double > &u) const
void	copyValues (std::span< double > u) const

Private Attributes
LIS_VECTOR	vec_

Member Typedef Documentation

IndexType

using MathLib::LisVector::IndexType = LIS_INT

Definition at line 22 of file LisVector.h.

Constructor & Destructor Documentation

LisVector() [1/3]

MathLib::LisVector::LisVector ( std::size_t length )

explicit

Constructor for initialization of the number of rows

Parameters

length

number of rows

Definition at line 10 of file LisVector.cpp.

{
    lis_vector_create(0, &vec_);
    lis_vector_set_size(vec_, 0, length);
}

References vec_.

Referenced by LisVector().

LisVector() [2/3]

MathLib::LisVector::LisVector	(	std::size_t	length,
		double *	data )

Constructor using the given raw data

Parameters

length	the length of the vector
data	the raw data

Definition at line 16 of file LisVector.cpp.

{
    lis_vector_create(0, &vec_);
    lis_vector_set_size(vec_, 0, length);
    for (std::size_t i = 0; i < length; i++)
        lis_vector_set_value(LIS_INS_VALUE, i, data[i], vec_);
}

References vec_.

LisVector() [3/3]

MathLib::LisVector::LisVector

(

LisVector const &

src

)

copy constructor

Definition at line 24 of file LisVector.cpp.

{
    lis_vector_duplicate(src.vec_, &vec_);
    lis_vector_copy(src.vec_, vec_);
}

References LisVector(), and vec_.

~LisVector()

MathLib::LisVector::~LisVector ( )

virtual

Definition at line 30 of file LisVector.cpp.

{
    lis_vector_destroy(vec_);
}

References vec_.

Member Function Documentation

add() [1/2]

template<class T_SUBVEC>

void MathLib::LisVector::add ( const std::vector< IndexType > & pos, const T_SUBVEC & sub_vec )

inline

add entries

Definition at line 96 of file LisVector.h.

    {
        for (std::size_t i = 0; i < pos.size(); ++i)
        {
            add(pos[i], sub_vec[i]);
        }
    }

References add().

add() [2/2]

void MathLib::LisVector::add ( IndexType rowId, double v )

inline

add entry

Definition at line 73 of file LisVector.h.

    {
        lis_vector_set_value(LIS_ADD_VALUE, rowId, v, vec_);
    }

References MathLib::v, and vec_.

Referenced by add().

copyValues() [1/2]

void MathLib::LisVector::copyValues ( std::span< double > u ) const

inline

Copy local entries to a span.

Parameters

u	a span for the values of local entries of correct size. If the sizes mismatch, exception will be thrown.

Definition at line 116 of file LisVector.h.

    {
        if (u.size() != size())
        {
            OGS_FATAL(
                "LisVector::copyValues() size mismatch. Trying to copy a "
                "vector "
                "of size {:d} to a span of size {:d}.",
                size(), u.size());
        }
        lis_vector_get_values(vec_, 0, size(), u.data());
    }

References OGS_FATAL, size(), MathLib::u, and vec_.

copyValues() [2/2]

void MathLib::LisVector::copyValues ( std::vector< double > & u ) const

inline

Copy local entries to a vector.

Parameters

u	a vector for the values of local entries. It will be resized to hold the current vector data.

Definition at line 107 of file LisVector.h.

    {
        u.resize(size());
        lis_vector_get_values(vec_, 0, size(), u.data());
    }

References size(), MathLib::u, and vec_.

get()

double MathLib::LisVector::get ( IndexType rowId ) const

inline

get entry

Definition at line 59 of file LisVector.h.

    {
        double v = .0;
        lis_vector_get_value(vec_, rowId, &v);
        return v;
    }

References MathLib::v, and vec_.

Referenced by operator[]().

getRangeBegin()

std::size_t MathLib::LisVector::getRangeBegin ( ) const

inline

return a start index of the active data range

Definition at line 49 of file LisVector.h.

{ return 0; }

getRangeEnd()

std::size_t MathLib::LisVector::getRangeEnd ( ) const

inline

return an end index of the active data range

Definition at line 51 of file LisVector.h.

{ return this->size(); }

References size().

getRawVector()

LIS_VECTOR & MathLib::LisVector::getRawVector ( )

inline

return a raw Lis vector object

Definition at line 82 of file LisVector.h.

{ return vec_; }

References vec_.

Referenced by MathLib::EigenLisLinearSolver::solve().

operator[]()

double MathLib::LisVector::operator[] ( IndexType rowId ) const

inline

access entry

Definition at line 57 of file LisVector.h.

{ return get(rowId); }

References get().

set() [1/2]

template<class T_SUBVEC>

void MathLib::LisVector::set ( const std::vector< IndexType > & pos, const T_SUBVEC & sub_vec )

inline

set entries

Definition at line 86 of file LisVector.h.

    {
        for (std::size_t i = 0; i < pos.size(); ++i)
        {
            set(pos[i], sub_vec[i]);
        }
    }

References set().

set() [2/2]

void MathLib::LisVector::set ( IndexType rowId, double v )

inline

set entry

Definition at line 67 of file LisVector.h.

    {
        lis_vector_set_value(LIS_INS_VALUE, rowId, v, vec_);
    }

References MathLib::v, and vec_.

Referenced by set().

setZero()

void MathLib::LisVector::setZero ( )

inline

Definition at line 54 of file LisVector.h.

{ lis_vector_set_all(0.0, vec_); }

References vec_.

size()

std::size_t MathLib::LisVector::size

(

)

const

return a vector length

Definition at line 35 of file LisVector.cpp.

{
    IndexType dummy;
    IndexType size;
    int const ierr = lis_vector_get_size(vec_, &dummy, &size);
    checkLisError(ierr);
    assert(size >= 0);  // For safe implicit conversion to std::size_t.
    return size;
}

References MathLib::checkLisError(), size(), and vec_.

Referenced by copyValues(), copyValues(), getRangeEnd(), size(), and MathLib::EigenLisLinearSolver::solve().

write()

void MathLib::LisVector::write

(

const std::string &

filename

)

const

printout this equation for debugging

Definition at line 45 of file LisVector.cpp.

{
    lis_output_vector(vec_, LIS_FMT_PLAIN, const_cast<char*>(filename.c_str()));
}

References vec_.

Member Data Documentation

vec_

LIS_VECTOR MathLib::LisVector::vec_

private

Definition at line 130 of file LisVector.h.

Referenced by LisVector(), LisVector(), LisVector(), ~LisVector(), add(), copyValues(), copyValues(), get(), getRawVector(), set(), setZero(), size(), and write().

---

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

• LisVector.h
• LisVector.cpp