num::ScalarField3D Class Reference

#include <fields.hpp>

Public Member Functions
	ScalarField3D (int nx, int ny, int nz, float dx, float ox=0.0f, float oy=0.0f, float oz=0.0f)
Grid3D &	grid ()
const Grid3D &	grid () const
int	nx () const
int	ny () const
int	nz () const
float	dx () const
float	ox () const
float	oy () const
float	oz () const
void	set (int i, int j, int k, double v)
void	fill (double v)
float	sample (float x, float y, float z) const

Detailed Description

Definition at line 21 of file fields.hpp.

Constructor & Destructor Documentation

ScalarField3D()

num::ScalarField3D::ScalarField3D	(	int	nx,
		int	ny,
		int	nz,
		float	dx,
		float	ox = 0.0f,
		float	oy = 0.0f,
		float	oz = 0.0f
	)

Parameters

nx,ny,nz	Grid resolution
dx	Cell size [m]
ox,oy,oz	World-space origin

Definition at line 14 of file fields.cpp.

Member Function Documentation

dx()

float num::ScalarField3D::dx ( ) const

inline

Definition at line 35 of file fields.hpp.

References num::Grid3D::dx().

Referenced by sample(), and num::MagneticSolver::solve_magnetic_field().

fill()

void num::ScalarField3D::fill ( double  v )

inline

Definition at line 41 of file fields.hpp.

References num::Grid3D::fill().

grid() [1/2]

Grid3D & num::ScalarField3D::grid ( )

inline

Definition at line 29 of file fields.hpp.

Referenced by num::MagneticSolver::current_density(), physics::ElectricSolver::joule_heating(), main(), num::VectorField3D::scale(), num::FieldSolver::solve_poisson(), and physics::ElectricSolver::solve_potential().

grid() [2/2]

const Grid3D & num::ScalarField3D::grid ( ) const

inline

Definition at line 30 of file fields.hpp.

nx()

int num::ScalarField3D::nx ( ) const

inline

Definition at line 32 of file fields.hpp.

References num::Grid3D::nx().

Referenced by sample(), and num::MagneticSolver::solve_magnetic_field().

ny()

int num::ScalarField3D::ny ( ) const

inline

Definition at line 33 of file fields.hpp.

References num::Grid3D::ny().

Referenced by sample(), and num::MagneticSolver::solve_magnetic_field().

nz()

int num::ScalarField3D::nz ( ) const

inline

Definition at line 34 of file fields.hpp.

References num::Grid3D::nz().

Referenced by sample(), and num::MagneticSolver::solve_magnetic_field().

ox()

float num::ScalarField3D::ox ( ) const

inline

Definition at line 36 of file fields.hpp.

Referenced by num::MagneticSolver::solve_magnetic_field().

oy()

float num::ScalarField3D::oy ( ) const

inline

Definition at line 37 of file fields.hpp.

Referenced by num::MagneticSolver::solve_magnetic_field().

oz()

float num::ScalarField3D::oz ( ) const

inline

Definition at line 38 of file fields.hpp.

Referenced by num::MagneticSolver::solve_magnetic_field().

sample()

float num::ScalarField3D::sample	(	float	x,
		float	y,
		float	z
	)		const

Trilinear interpolation at world position (x,y,z). Returns 0 outside the grid domain.

Definition at line 19 of file fields.cpp.

References dx(), num::ipow(), nx(), ny(), and nz().

Referenced by num::VectorField3D::sample().

set()

void num::ScalarField3D::set ( int  i, int  j, int  k, double  v  )

inline

Definition at line 40 of file fields.hpp.

References num::ipow(), and num::Grid3D::set().

---

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

• /home/runner/work/numerics/numerics/include/pde/fields.hpp
• /home/runner/work/numerics/numerics/src/pde/fields.cpp
• /home/runner/work/numerics/numerics/src/spatial/fields.cpp