List of all members
DataVector Class Reference

Stores a collection of function values. More...

#include <DataVector.hpp>

Additional Inherited Members

- Public Types inherited from VectorImpl< double, DataVector >
using value_type = double
 
using size_type = size_t
 
using difference_type = std::ptrdiff_t
 
using BaseType = PointerVector< double, blaze::unaligned, blaze::unpadded, blaze::defaultTransposeFlag, DataVector >
 
using ElementType = double
 
using TransposeType = VectorImpl< double, DataVector >
 
using CompositeType = const VectorImpl< double, DataVector > &
 
using iterator = typename BaseType::Iterator
 
using const_iterator = typename BaseType::ConstIterator
 
- Public Member Functions inherited from VectorImpl< double, DataVector >
 VectorImpl (size_t set_size) noexcept
 Create with the given size. In debug mode, the vector is initialized to 'NaN' by default. If not initialized to 'NaN', the memory is allocated but not initialized. More...
 
 VectorImpl (size_t set_size, double value) noexcept
 Create with the given size and value. More...
 
 VectorImpl (double *start, size_t set_size) noexcept
 Create a non-owning VectorImpl that points to start
 
 VectorImpl (std::initializer_list< U > list) noexcept
 Create from an initializer list of T.
 
 VectorImpl ()=default
 Empty VectorImpl.
 
 VectorImpl (const VectorImpl< double, DataVector > &rhs) noexcept
 
 VectorImpl (VectorImpl< double, DataVector > &&rhs) noexcept
 
VectorImploperator= (const double &rhs) noexcept
 
bool is_owning () const noexcept
 Returns true if the class owns the data.
 
void pup (PUP::er &p) noexcept
 Serialization for Charm++.
 
const BaseTypeoperator~ () const noexcept
 Upcast to BaseType More...
 
BaseTypeoperator~ () noexcept
 Upcast to BaseType More...
 
void set_data_ref (gsl::not_null< DataVector * > rhs) noexcept
 Set the VectorImpl to be a reference to another VectorImpl object.
 
void set_data_ref (double *const start, const size_t set_size) noexcept
 Set the VectorImpl to be a reference to another VectorImpl object.
 
- Static Public Attributes inherited from VectorImpl< double, DataVector >
static constexpr bool transpose_flag
 
- Protected Member Functions inherited from VectorImpl< double, DataVector >
void reset_pointer_vector (const size_t set_size) noexcept
 
- Protected Attributes inherited from VectorImpl< double, DataVector >
std::unique_ptr< value_type[], decltype(&free)> owned_data_
 
bool owning_
 

Detailed Description

Stores a collection of function values.

Details

Use DataVector to represent function values on the computational domain. Note that interpreting the data also requires knowledge of the points that these function values correspond to.

A DataVector holds an array of contiguous data. The DataVector can be owning, meaning the array is deleted when the DataVector goes out of scope, or non-owning, meaning it just has a pointer to an array.

Refer to the Data Structures documentation for a list of other available types. In particular, to represent a generic vector that supports common vector and matrix operations and whose meaning may not be of function values at points, use DenseVector instead.

DataVectors support a variety of mathematical operations that are applicable to nodal coefficients. In addition to common arithmetic operations such as elementwise addition, subtraction, multiplication and division, the elementwise operations on blaze vectors of doubles are supported. See blaze-wiki/Vector_Operations.

In addition, the Heaviside step function step_function is supported for DataVectors.


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