A class which helps with repeated reading from a petsc vector. More...

#include <PetscVectorReader.h>

Public Member Functions
	PetscVectorReader (PetscVector< Number > &vec)
	Construct using a pets vector.

	PetscVectorReader (NumericVector< Number > &vec)
	Construct using a numeric vector.

	~PetscVectorReader ()
	Destructor to make sure the vector is restored every time this goes out of scope.

void	restore ()
	Restore the array, usually upon going out of scope.

PetscScalar	operator() (const numeric_index_type i) const
	Access a value in the petsc vector.

Private Member Functions
bool	readable () const
	Check if this vector is readable.

Private Attributes
PetscVector< Number > &	_vec
	Reference to the petsc vector whose values shall be read.

const PetscScalar *	_raw_value
	The raw values in the vector.

Detailed Description

A class which helps with repeated reading from a petsc vector.

Its main purpose is to avoid unnecessary calls to the get_array() function in the wrapper.

Definition at line 27 of file PetscVectorReader.h.

Constructor & Destructor Documentation

◆ PetscVectorReader() [1/2]

PetscVectorReader::PetscVectorReader ( PetscVector< Number > & vec )

Construct using a pets vector.

Definition at line 12 of file PetscVectorReader.C.

  : _vec(vec), _raw_value(vec.get_array_read())
{
}

◆ PetscVectorReader() [2/2]

PetscVectorReader::PetscVectorReader ( NumericVector< Number > & vec )

Construct using a numeric vector.

Definition at line 17 of file PetscVectorReader.C.

  : _vec(libMesh::cast_ref<PetscVector<Number> &>(vec)), _raw_value(_vec.get_array_read())
{
}

◆ ~PetscVectorReader()

PetscVectorReader::~PetscVectorReader ( )

Destructor to make sure the vector is restored every time this goes out of scope.

Definition at line 22 of file PetscVectorReader.C.

22{ restore(); }

PetscVectorReader::restore

void restore()

Restore the array, usually upon going out of scope.

Definition PetscVectorReader.C:25

Member Function Documentation

◆ operator()()

PetscScalar PetscVectorReader::operator() ( const numeric_index_type i ) const

inline

Access a value in the petsc vector.

Definition at line 58 of file PetscVectorReader.h.

{
  mooseAssert(readable(), "Not readable");
  const numeric_index_type local_index = _vec.map_global_to_local_index(i);
  return _raw_value[local_index];
}

◆ readable()

bool PetscVectorReader::readable ( ) const

inlineprivate

Check if this vector is readable.

Definition at line 48 of file PetscVectorReader.h.

48{ return _raw_value != nullptr; }

Referenced by operator()(), and restore().

◆ restore()

void PetscVectorReader::restore ( )

Restore the array, usually upon going out of scope.

Definition at line 25 of file PetscVectorReader.C.

{
  mooseAssert(readable(), "Array not retrieved");
  _vec.restore_array();
  _raw_value = nullptr;
}

Referenced by ~PetscVectorReader().

Member Data Documentation

◆ _raw_value

const PetscScalar* PetscVectorReader::_raw_value

private

The raw values in the vector.

Definition at line 54 of file PetscVectorReader.h.

Referenced by operator()(), readable(), and restore().

◆ _vec

PetscVector<Number>& PetscVectorReader::_vec