occ
Loading...
Searching...
No Matches
occ::isosurface::VolumeData Struct Reference

Clean volumetric data representation using Eigen::Tensor. More...

#include <volume_data.h>

Public Member Functions

int nx () const
 
int ny () const
 
int nz () const
 
size_t total_points () const
 
Vec3 spacing () const
 
Vec3 dimensions () const
 
Vec3 grid_to_coords (int i, int j, int k) const
 
double & operator() (int i, int j, int k)
 
const double & operator() (int i, int j, int k) const
 

Public Attributes

Vec3 origin
 
Mat3 basis
 
IVec3 steps
 
std::vector< core::Atomatoms
 
Eigen::Tensor< double, 3 > data
 
std::string name
 
VolumePropertyKind property
 

Detailed Description

Clean volumetric data representation using Eigen::Tensor.

This struct holds all the data needed to represent a 3D scalar field on a regular grid, with proper linear algebra types.

Member Function Documentation

◆ dimensions()

Vec3 occ::isosurface::VolumeData::dimensions ( ) const
inline

◆ grid_to_coords()

Vec3 occ::isosurface::VolumeData::grid_to_coords ( int  i,
int  j,
int  k 
) const
inline

◆ nx()

int occ::isosurface::VolumeData::nx ( ) const
inline

◆ ny()

int occ::isosurface::VolumeData::ny ( ) const
inline

◆ nz()

int occ::isosurface::VolumeData::nz ( ) const
inline

◆ operator()() [1/2]

double & occ::isosurface::VolumeData::operator() ( int  i,
int  j,
int  k 
)
inline

◆ operator()() [2/2]

const double & occ::isosurface::VolumeData::operator() ( int  i,
int  j,
int  k 
) const
inline

◆ spacing()

Vec3 occ::isosurface::VolumeData::spacing ( ) const
inline

◆ total_points()

size_t occ::isosurface::VolumeData::total_points ( ) const
inline

Member Data Documentation

◆ atoms

std::vector<core::Atom> occ::isosurface::VolumeData::atoms

◆ basis

Mat3 occ::isosurface::VolumeData::basis

◆ data

Eigen::Tensor<double, 3> occ::isosurface::VolumeData::data

◆ name

std::string occ::isosurface::VolumeData::name

◆ origin

Vec3 occ::isosurface::VolumeData::origin

◆ property

VolumePropertyKind occ::isosurface::VolumeData::property

◆ steps

IVec3 occ::isosurface::VolumeData::steps

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