STORMM Source Documentation
Loading...
Searching...
No Matches
stormm::structure::TricubicStencil Class Reference

A bundle of a 64 x 64 matrix, encoding the transformation of function values and derivatives at a stencil of points inside a tricubic mesh element into coefficients for that mesh element expressing the interpolated tricubic function. The type of stencil is also indicated, to keep this information coupled. More...

#include <tricubic_cell.h>

Public Member Functions

 TricubicStencil (Interpolant kind_in=Interpolant::SMOOTHNESS)
 The constructor accepts the stencil type. Dimensions of the matrix and the geometry of each stencil option are hard-wired.
 
Interpolant getKind () const
 Get the type of interpolant.
 
const double * data (HybridTargetLevel tier=HybridTargetLevel::HOST) const
 Get a pointer to the matrix data on the host or device.
 
std::vector< double > exportMatrix () const
 Export the matrix as a Standard-Template Library vector.
 
 TricubicStencil (const TricubicStencil &original)=default
 The copy and move constructors as well as assignment operators can all take their default forms. There are no const members or pointers to repair.
 
 TricubicStencil (TricubicStencil &&original)=default
 
TricubicStenciloperator= (const TricubicStencil &original)=default
 
TricubicStenciloperator= (TricubicStencil &&original)=default
 

Detailed Description

A bundle of a 64 x 64 matrix, encoding the transformation of function values and derivatives at a stencil of points inside a tricubic mesh element into coefficients for that mesh element expressing the interpolated tricubic function. The type of stencil is also indicated, to keep this information coupled.

Constructor & Destructor Documentation

◆ TricubicStencil()

stormm::stmath::TricubicStencil::TricubicStencil ( const TricubicStencil & original)
default

The copy and move constructors as well as assignment operators can all take their default forms. There are no const members or pointers to repair.

Parameters
originalThe original object to copy or move
otherA pre-existing object to copy or move

Member Function Documentation

◆ data()

const double * stormm::stmath::TricubicStencil::data ( HybridTargetLevel tier = HybridTargetLevel::HOST) const

Get a pointer to the matrix data on the host or device.

Parameters
tierSpecify whether to obtain data on the CPU host or GPU device

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