TDMS
Time Domain Maxwell Solver
All Classes Namespaces Files Functions Variables Typedefs Enumerations Macros Pages
Grid Class Reference

#include <field.h>

Inheritance diagram for Grid:
[legend]
Collaboration diagram for Grid:
[legend]

Public Member Functions

int max_IJK_tot () const
 
void set_preferred_interpolation_methods (tdms_flags::InterpolationMethod im)
 Set the preferred interpolation methods.
 

Public Attributes

IJKDimensions tot = {0, 0, 0}
 

Protected Attributes

tdms_flags::InterpolationMethod interpolation_method
 

Detailed Description

A generic grid entity. For example:

     ______________________ (2, 1, 0)
    /           /         /
   /           /         /
  /___________/_________/

(0, 0, 0) (1, 0, 0) (2, 0, 0)

has I_tot = 2, J_tot = 1, K_tot = 0.

NOTE: For storage purposes, this means that field values associated to cells are stored to the left. That is, Grid(0,0,0) is associated to the cell (-1,-1,-1). This is contrary to the way values are associated to cells, where cell (0,0,0) is associated to the field values (0,0,0).

Member Function Documentation

◆ max_IJK_tot()

int Grid::max_IJK_tot ( ) const
inline

Maximum value out of I_tot, J_tot and K_tot

Returns
value

Member Data Documentation

◆ interpolation_method

tdms_flags::InterpolationMethod Grid::interpolation_method
protected
Initial value:
=
tdms_flags::InterpolationMethod::Cubic

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