TDMS
Time Domain Maxwell Solver
All Classes Namespaces Files Functions Variables Typedefs Enumerations Macros Pages
CurrentDensitySplitField Class Reference
Inheritance diagram for CurrentDensitySplitField:
[legend]
Collaboration diagram for CurrentDensitySplitField:
[legend]

Public Member Functions

 CurrentDensitySplitField (int I_total, int J_total, int K_total)
 
double interpolate_to_centre_of (AxialDirection d, CellCoordinate cell) override
 Interpolates a SplitField component to the centre of a Yee cell.
 
- Public Member Functions inherited from SplitField
 SplitField ()=default
 
 SplitField (int I_total, int J_total, int K_total)
 
void allocate ()
 
void zero ()
 
void allocate_and_zero ()
 
void initialise_fftw_plan (int n_threads, EHVec &eh_vec)
 
double largest_field_value ()
 Fetches the largest absolute value of the field.
 
- Public Member Functions inherited from Grid
int max_IJK_tot () const
 
void set_preferred_interpolation_methods (tdms_flags::InterpolationMethod im)
 Set the preferred interpolation methods.
 

Protected Member Functions

int delta_n () override
 

Additional Inherited Members

- Public Attributes inherited from SplitField
SplitFieldComponent xy
 
SplitFieldComponent xz
 
SplitFieldComponent yx
 
SplitFieldComponent yz
 
SplitFieldComponent zx
 
SplitFieldComponent zy
 
- Public Attributes inherited from Grid
IJKDimensions tot = {0, 0, 0}
 
- Protected Attributes inherited from Grid
tdms_flags::InterpolationMethod interpolation_method
 

Constructor & Destructor Documentation

◆ CurrentDensitySplitField()

CurrentDensitySplitField::CurrentDensitySplitField ( int  I_total,
int  J_total,
int  K_total 
)
inline

Constructor of the field with a defined size in the x, y, z Cartesian dimensions

Member Function Documentation

◆ delta_n()

int CurrentDensitySplitField::delta_n ( )
inlineoverrideprotectedvirtual

Implements SplitField.

◆ interpolate_to_centre_of()

double CurrentDensitySplitField::interpolate_to_centre_of ( AxialDirection  d,
CellCoordinate  cell 
)
inlineoverridevirtual

Interpolates a SplitField component to the centre of a Yee cell.

Parameters
dSplitField component to interpolate
cellIndex (i,j,k) of the Yee cell to interpolate to the centre of
Returns
double The interpolated field value

Implements SplitField.


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