num::Grid3D Struct Reference

#include <grid3d.hpp>

Public Member Functions
int	size () const
idx	flat (int i, int j, int k) const
double	x (int i) const
double	y (int j) const
double	z (int k) const

Public Attributes
int	nx
int	ny
int	nz
	nodes per axis
double	dx = 1.0
	uniform cell size
double	ox = 0.0
double	oy = 0.0
double	oz = 0.0
	origin (physical coordinate of node 0)

Detailed Description

Definition at line 14 of file grid3d.hpp.

Member Function Documentation

flat()

idx num::Grid3D::flat ( int  i, int  j, int  k  ) const

inline

Definition at line 21 of file grid3d.hpp.

References nx, and ny.

Referenced by num::ScalarField3D::fill(), num::ScalarField3D::operator()(), num::ScalarField3D::operator()(), and num::ScalarField3D::set().

size()

int num::Grid3D::size ( ) const

inline

Definition at line 19 of file grid3d.hpp.

References nx, ny, and nz.

x()

double num::Grid3D::x ( int  i ) const

inline

Definition at line 25 of file grid3d.hpp.

References dx, and ox.

y()

double num::Grid3D::y ( int  j ) const

inline

Definition at line 26 of file grid3d.hpp.

References dx, and oy.

z()

double num::Grid3D::z ( int  k ) const

inline

Definition at line 27 of file grid3d.hpp.

References dx, and oz.

Member Data Documentation

dx

double num::Grid3D::dx = 1.0

uniform cell size

Definition at line 16 of file grid3d.hpp.

Referenced by num::ScalarField3D::dx(), x(), y(), and z().

nx

int num::Grid3D::nx

Definition at line 15 of file grid3d.hpp.

Referenced by num::ScalarField3D::fill(), flat(), num::ScalarField3D::nx(), and size().

ny

int num::Grid3D::ny

Definition at line 15 of file grid3d.hpp.

Referenced by num::ScalarField3D::fill(), flat(), num::ScalarField3D::ny(), and size().

nz

int num::Grid3D::nz

nodes per axis

Definition at line 15 of file grid3d.hpp.

Referenced by num::ScalarField3D::fill(), num::ScalarField3D::nz(), and size().

ox

double num::Grid3D::ox = 0.0

Definition at line 17 of file grid3d.hpp.

Referenced by num::ScalarField3D::ox(), and x().

oy

double num::Grid3D::oy = 0.0

Definition at line 17 of file grid3d.hpp.

Referenced by num::ScalarField3D::oy(), and y().

oz

double num::Grid3D::oz = 0.0

origin (physical coordinate of node 0)

Definition at line 17 of file grid3d.hpp.

Referenced by num::ScalarField3D::oz(), and z().

---

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

• /home/runner/work/numerics/numerics/include/fields/grid3d.hpp