CTmcRTH_Indan();          // обнуляет поля, очищает ошибку
virtual ~CTmcRTH_Indan(); // вызывает DeleteData() (удаляет временный файл)

CTmcRTH_Indan cIndan;

// 1. Задать входной .tpl и прогнать препроцессор
cIndan.SetTplFileName( "task.tpl" );
if( cIndan.IsError() ) { /* cIndan.GetErrorMessage() */ }

// 2. Узнать число шагов
int nSteps = cIndan.GetNStepMax();

// 3. Прочитать данные нужного шага
cIndan.ReadData( "task.tpl", 0 );

// 4. Получить параметры, топологию, вывод
CTmcRTH_IndanParam   &p   = cIndan.GetParam();
CTmcRTH_IndanTopology&t   = cIndan.GetTopology();
CTmcRTH_IndanOutput  *out = cIndan.GetOutput();

int nX, nY;  cIndan.GetnXnY( nX, nY );
double delta = cIndan.dGetDelta();

// 5. Обойти блоки топологии
for( CTmcRTH_BlockList *b = t.GetBlockList(); b && b->GetnBlock()!=0; b = b->GetNext() )
{
    int    type    = b->GetnType();      // код типа (eps/metal/absorber/...)
    CString epsExpr = b->GetcsEpsExpr();  // выражение eps
}

The TMCIndan library — API documentation

TMC Suite package. A static library — reading the computation input template file (.tpl), storing the topology of a planar structure (primitive blocks), the computation parameters, the output section, as well as time-integrating the field and exporting it to a radiation pattern. All signatures are taken from the sources in src/libs/TMCIndan/ and the shared headers from src/Include/.

---

1. Purpose of the library

TMCIndan is a static library (StaticLibrary) linked by the compute kernels PlanarRT_H and PlanarRT_X (see CLAUDE.md, the "Library dependencies" section). Its task is to turn the text computation input file (.tpl) into an object model of the computational task:

• launching the PREPR preprocessor over the .tpl (creating a temporary expanded file);
• parsing the sections of the input file: parameters (#PARM), topology (#TOPOLOGY), the block link list (#LINK_LIST), output (#OUTPUT), steps (#STEP);
• storing the topology as a singly linked list of primitive blocks (rectangles, circles, polygons, eps-distribution files, inputs/excitations), each with its own expression for the permittivity, permeability, losses, etc.;
• storing the global parameters of the computation (units, the grid Delta, the area boundaries Xmin..Ymax, the frequency, the time, the height);
• storing the output settings (output file names, flags for outputting the S-matrix, the field, the topology);
• integrating the field over time (accumulating the amplitude and phase of Ez) and exporting it to a radiation-pattern file.

The name "Indan" (induced currents / "indan blocks") and part of the applied semantics belong to the project's scientific model. The computation math must not be edited (see CLAUDE.md). What is documented here is the programming interface, not the physical meaning of the formulas.

---

2. Source location and build composition

Sources: src/libs/TMCIndan/. Headers: src/Include/ (included as <TmcRTH_*.h>). The build project is TMCIndan.vcxproj (type StaticLibrary, Win32/x64 configurations).

The build contains 8 .cpp files:

The directory src/Include/Indan/ holds older copies of some of these headers (TmcRTH_Indan.h, TmcRTH_IndanOutput.h, TmcRTH_IndanTopology.h, TmcRTH_Input.h, TmcRTH_InputNode.h, FieldIntegrated.h, plus TmcRTHNodeDiel.h, TmcRTHRectNode.h, Pl_iofor1.h). They are not part of the TMCIndan.vcxproj build: the project includes the headers from ..\..\INCLUDE\. The files TmcRTHNodeDiel.h, TmcRTHRectNode.h, Pl_iofor1.h belong to the compute-kernel implementation (the classes inherit CWnd) and are not described here as part of the library.

---

3. Base types and dependencies

The library relies on shared headers and types:

_real in the current build = float (in typerth.h the #define _PREC_FLOAT is active).

The node value type _ELEM_VAL_RTH

_ELEM_VAL_RTH is the type of the stored voltage value at a node. By default _ELEM_VAL_RTH_REAL equals _real. The alternative _ELEM_VAL_RTH_INT (an integer representation with the factor 2^20) is not active in the current build.

---

4. Free (non-member) functions

void MainPrepr( CString csTplFileNamePrepr, CString csTplFileName, CString csCurrentPath, CTmcLibError &cError )

Declared in: TmcRTH_Indan.h. What it does: a wrapper over the PREPR preprocessor. It launches the expansion of the input template csTplFileName (the #define/#include directives, comment removal) and writes the result into the temporary file csTplFileNamePrepr.

Errors: the error message is placed into cError.

Functions controlling the global step DELTA_T (declared in TmcRTH_IndanParam.h)

Global functions for working with the mechanical time step (the flag and the value are stored globally, outside the class):

These functions are also declared in typerth.h; their implementation may be in the compute kernel. The purpose of the "mechanical" step relates to the moving-block model (RECT_MOVE, CIRCLE_MOVE).

---

5. The CTmcRTH_Indan class — the main .tpl reading facade

Purpose: the top-level interface of the library. It opens the .tpl file, runs it through PREPR into a temporary file, finds and reads the sections (#PARM, #TOPOLOGY, #LINK_LIST, #OUTPUT) for a given step (#STEP), and exposes the parameters, topology and output settings. Header: src/Include/TmcRTH_Indan.h Depends on: TmcLibError.h, TmcRTH_IndanParam.h, TmcRTH_IndanOutput.h, TmcRTH_IndanTopology.h, PREPR.

Important header constants (macros)

Fields (private)

Constructor / destructor

CTmcRTH_Indan();          // zeroes the fields, clears the error
virtual ~CTmcRTH_Indan(); // calls DeleteData() (deletes the temporary file)

Public methods

void SetTplFileName( CString csFileName ) and void SetTplFileName( char *pszFileName )

What it does: sets the input .tpl name, checks that the file can be opened, determines the current directory and launches PREPR (creates the temporary expanded file). How it works: DeleteData() → fopen(csFileName,"r") (check) → SetCurrentPath() → forms csTplFileNamePrepr = the name + CTMCRTH_INDANPREPRFNA → MakePreprFile(). Errors: "can't open file …", "very long file name …" — in cError.

void ReadData( CString csFileName, int nStepNum )

What it does: fully reads the data of step nStepNum from the file csFileName (sets the name, finds the step, reads all sections).

void SetStepNumber( int nStep1 )

What it does: sets the current step number.

void ReadParamSection(), void ReadTopologySection(), void ReadLinkListSection(), void ReadOutputSection()

What they do: read the corresponding section of the current step from the temporary file. Internally they find the section boundaries by markers (FindSection) and pass the contents to cParam.Read(), cTopology.Read(), cTopology.ReadLink(), cOut.Read().

int GetNStepMax( void ) and int GetNStepMax( CString csFileName )

What it does: returns the number of steps (#STEP) in the file. The overload with a string sets the file first. Returns: the number of steps.

Parameter and result getters

Error handling

Output flags (delegated to cOut)

void OnOffSoundEffects(), void OnOffFieldOutput(), void OnOffFieldOutput1(), void OnOffFieldOutputU(), void OnOffSinchronizationFieldOutput() — toggle the corresponding output flags (sound, field, field-1, field-U, synchronous field output).

CTmcLibError WriteFileForMaple( CString csFileName, CString csFileNameData, double dHeight, double dRolikR1, double dRolikR2, double dStatorR1, double dStatorR2, double dMagnMomP ) (+ a char* overload)

What it does: writes a file for the Maple system (export of geometry/data).

Returns: a CTmcLibError with the result.

Private methods (internal)

MakePreprFile() (launching PREPR), OpenPreprFile()/ClosePreprFile() (working with the temporary file), FindSection()/FindSection(char*,char*) (finding section boundaries), FindStep(int) (positioning at a step), CalcNStepMax() (counting steps), GetLine()/GetLineSection()/GetBlock() (line-by-line reading), del_blanks() (whitespace removal), SetCurrentPath(), DeleteData().

---

6. The CTmcRTH_IndanParam class — the global computation parameters

Purpose: stores the global parameters of the computation area and the units; recomputes grid nodes (node number coordinates). Header: src/Include/TmcRTH_IndanParam.h Depends on: typerth.h, TmcLibError.h.

Units (header macros)

For each quantity a triple "string identifier + string unit name + numeric factor to convert to SI" is defined:

Value identifiers: FREQ, DELTA, TIME, X_MIN, X_MAX, Y_MIN, Y_MAX, HEIGHT, DELTA_T_MECHANICAL.

Fields (public)

Methods

void Read( CString &csCh, CTmcLibError &cError1 )

What it does: parses the text of the #PARM section and fills the fields. Internally it recognizes the identifiers and calls the private ReadDelta, ReadFreq, ReadTime, ReadXmin/Xmax/Ymin/Ymax, ReadHeight, ReadDeltaTMechanical, as well as Read*Unit.

void IsCorrectly( CTmcLibError &cError1 )

What it does: checks the consistency of the parameters; recomputes rXmax/rYmax so that they fit into a whole number of Delta steps (rXmax = rXmin + CalcnX()*rDelta).

int CalcnX( void ) / int CalcnY( void )

What it does: the number of grid nodes along the axes. How it works: nX = (int)((Xmax−Xmin)/Delta)+1 (the same for Y). When |Delta| < FLT_MIN it returns 0 (protection against division by zero). Returns: the number of nodes (int).

int CalcnNodeGlobal( double x, double y )

What it does: converts the coordinates (x,y) into a global grid-node number. How it works: the point is clamped to the area boundaries; the index = iy*nX + ix, where ix, iy are the indices rounded by Delta (accounting for the boundary half-cells).

Returns: the global node number (≥0).

int CalcnNodeGlobalFM( double x, double y )

The same as CalcnNodeGlobal, but with a different boundary offset (1.5*Delta instead of 0.5*Delta).

int CalcnNodeGlobalNorm( double x, double y )

What it does: like CalcnNodeGlobal, but if the point is closer than 2·Delta to the area boundary — returns −1 (the point is not in the "normal" interior zone). Returns: the node number or −1.

double CalcX( int nNumber ) / double CalcY( int nNumber )

What it does: the reverse transformation — the node coordinate by its global number. How it works: nX=(int)((Xmax−Xmin)/Delta)+1; CalcX: the remainder nNumber mod nX, the coordinate Xmin+ix*Delta; CalcY: the integer nNumber/nX, the coordinate Ymin+iy*Delta.

BOOL IsnInRegion( int n ) / BOOL IsnInRegion( _real x, _real y )

What it does: checks whether a node (by number or by coordinates) falls within the grid [0, nX*nY). Returns: TRUE/FALSE.

Getters

double dGetDelta(), double dGetdT(), double dGetTmin(), int nGetTmax(), double dGetHeight(), double rGetLongUnit(), CString csGetLongUnit(), void GetXYMinMax(double&,double&,double&,double&).

CTmcRTH_IndanParam& operator=( CTmcRTH_IndanParam& cParam )

Copy assignment (all fields).

Private methods

Read*Unit (parsing units), Read* (parsing individual parameters), Search_1Param() (finding a value by identifier in a line), expr_del_Blanks2() (removing spaces in an expression), DeleteData().

---

7. The CTmcRTH_IndanTopology class — the topology (a wrapper over the block list)

Purpose: links the block list CTmcRTH_BlockList with the parameters CTmcRTH_IndanParam; reads the topology section and the link section. Header: src/Include/TmcRTH_IndanTopology.h Depends on: TmcRTH_BolckList.h, TmcRTH_IndanParam.h.

Fields (private)

Methods

---

8. The CTmcRTH_BlockList class — the list of primitive topology blocks

Purpose: a singly linked list of "blocks" — geometric primitives of a planar structure (rectangle, circle, polygon, eps distribution from a file, input/excitation). Each node stores the geometry, the type and the text expressions of the medium properties (eps, mu, losses, velocities, etc.). It reads a block description from text, checks correctness, and can save/load. Header: src/Include/TmcRTH_BolckList.h Depends on: TmcLibError.h, typerth.h, TmcRTH_IndanParam.h. The block-type names and codes are taken from Tmcgrviw.h.

Block types (string names, from Tmcgrviw.h)

Suffixes: _STAT — a static block, _N/_B/_Y — variants of the definition (see the Read*StatN/B implementation), _MOVE — a moving block (has velocities Vx,Vy,W).

Numeric type codes nType (from Tmcgrviw.h)

Eps-distribution file format constants (.eps)

TMC_RTH_EPSFILE_ID_ (the signature), TMC_RTH_EPSFILE_TYPE_, _Delta_, _XMIN_, _YMIN_, _NX_, _NY_, _NPoint_, _NAccur_, _NdFrmt_, _VlFrmt_ — the header keys of the .eps file. Also TMC_RTH_BLOCKLISTSAVE_BEGIN/_END — the block boundaries when saving; TMC_RTH_BLOCKLISTLOADBUFSIZE (20000) — the load-buffer size.

Fields (private)

Methods (public)

void Add( CString &csCh, CTmcLibError &cError, CTmcRTH_IndanParam *pcParam )

What it does: parses the text of a single block csCh and adds a new node to the end of the list.

void Add( CTmcRTH_BlockList &csCh )

What it does: adds a copy of a ready block to the end of the list (recursively going to the tail).

CTmcRTH_BlockList* FindBlock( int nBlock1 )

What it does: finds a block by number. Returns: a pointer to the block or NULL.

CTmcRTH_BlockList* GetNext( void )

Returns: the next block in the list (or NULL).

void SetLink( int iBuf, double x0, double y0, CTmcLibError &cError )

What it does: sets the link of the block numbered iBuf and its reference coordinates x0,y0.

void IsCorrectly( CTmcLibError &cError ) / void IsCorrectlyLink( CTmcLibError &cError )

What it does: checks the geometry/type of the block and the correctness of the links respectively.

BOOL Save( CString &csBuffer ) / BOOL Save1( CString &csBuffer )

What it does: serializes the list (Save1 — a format variant) into a string buffer. Returns: success.

void Load( FILE **fp, CTmcLibError &cError )

What it does: loads the block list from an open file.

void AddPathForFile( CString &csPath )

What it does: appends the directory path to the names of the distribution files (.eps) in blocks of type FILE.

Setters/getters

Geometry: SetX0/SetY0/GetX0/GetY0, SetXmin/SetXmax/SetYmin/SetYmax + the corresponding Get*, double* GetpX(), double* GetpY(), int GetnXY(). Type and number: SetnType(int)/GetnType(), SetnBlock(int)/GetnBlock(), SetcsBlock(CString)/GetcsBlock(), GetBlockNumber(). Memory: SetnMemory(int)/GetnMemory()/GetnMemoryAll(). Expressions: GetcsEpsExpr(), GetcsMuExpr(), GetcsDzExpr(), GetcsDzExprOut(), GetcsHxExpr(), GetcsHyExpr(), GetcsForceRo(), GetcsForceSigma(), GetcsForceConductivity(), GetcsFileNameMechanicalFreedomDegree(), GetcsVx(), GetcsVy(), GetcsW(). Other: operator=, DeleteData(), del_eol(char*).

Private methods (parsing specific types)

The families ReadFileStat*, ReadRectStat*, ReadCircleStat*, ReadPolygonStat* (with the N/B/_1 variants), ReadRectMove/ReadCircleMove/ReadPolygonMove, ReadInputX/ReadInputY, the common Read(), ReadXY() (reading a coordinate pair), Search_1Param(), expr_del_Blanks2(), CalcEOL()/SkipEOL(), IsFullName(), AddCurrentPath(), AddFileEpsExtention().

The class CTMCBlList is declared a friend (friend class CTMCBlList;) — it is an external class (from the viewers/kernel) given access to the private fields.

---

9. The CTmcRTH_IndanOutput class — the output settings

Purpose: stores the flags and file names for the computation-result output (S-matrix, field, topology, field distribution), and contains the field-integration object. Header: src/Include/TmcRTH_IndanOutput.h Depends on: TmcLibError.h, FieldIntegrated.h.

Output-section identifiers (macros)

FILE (CTMCRTH_FILEOUT_ID), TOPOLOGY (_TOPOLOGYOUT_ID), FIELDS (_FIELDSOUT_ID), SMATRIX (_SMATRIXOUT_ID), FIELD_DISTRIBUTION (_FLDSDSTROUT_ID), FIELD_DISTRIBUTION_M (_FLDSDSMROUT_ID).

Fields (public)

Methods

Private methods

ReadSmatrix(), ReadFileName(), ReadTopology(), ReadFields(), ReadFileDistr(), ReadFileDistrInMemory(), IsFullPath(), Search_1Param(), expr_del_Blanks2().

---

10. The CFieldIntegrated class — field integration and the radiation pattern

Purpose: accumulates (integrates) the field Ez values over time, computes the amplitude and phase at a given frequency, saves the result into files and exports it to a radiation-pattern file (by radiators along the area boundaries). Header: src/Include/FieldIntegrated.h Depends on: TmcLibError.h, TmcRTH_IndanParam.h.

Fields (private, key)

Methods (public)

void InitAllFile( int nX1, int nY1, double dDelta1, double dXmin1, double dYmin1, CTmcRTH_IndanParam& cParam1, double dT1 )

What it does: initializes the grid parameters and the working files before starting integration.

void Integrate( double dTCurrent1, int nTCurrent1, _real *prUNode1 )

What it does: adds the contribution of the current time layer of the field prUNode1 to the accumulated amplitude/phase.

void ExportToDirectionalPattern( CTmcRTH_IndanParam &cParam1 )

What it does: exports the accumulated field to a radiation-pattern file (the amplitude/phase of radiators along the boundaries Xmin/Xmax/Ymin/Ymax).

Setters/getters

SetnX/SetnY/SetnXnY, SetFreq/GetFreq, SetTmin/GetTmin, SetTmax/GetTmax, SetFile(...) (3 overloads), SetIntegrateInMemory(), BOOL bIsItegratedInMemory(), BOOL bIsFieldDistr(), CString GetcsDirectPatternFile(), void AddPath(CString), BOOL IsFullPath(), CTmcLibError& GetError(), CString GetErrorMessage(), BOOL IsError(), operator=, void DeleteData().

Private methods (internal)

The families AddDirectionalPatternFileXmin/Xmax/Ymin/Ymax (+ overloads with radiator parameters), ReadAmplitudaAndFazaX/Y, ReadAmplitudaAndFazaEz, MakeDirectionalPatternFile*, GetNumberOfEmittersAlongX/Y, IntegrateInMemory(), MakeFileAmplitudeAndFaza[FromMemory](), ReadParamFromFile() / ReadParamFrom1File(...), InitArrayForIntegrate(), InitFile(), SetDirectionalPatternParamDefault(), IsDirectionalPatternDataCorrect().

The exact physical normalization and integration formulas (sin/cos quadratures, the number of radiators) belong to the scientific model — they must not be changed.

---

11. The CTmcRTH_Input class — the excitation nodes (input)

Purpose: describes an "input" (an excitation source) — a set of nodes on the boundary with their own direction and signal expression. An internal auxiliary class. Header: src/Include/TmcRTH_Input.h Depends on: typerth.h, TmcRTH_InputNode.h.

Fields (private)

Constructor/destructor: CTmcRTH_Input(), ~CTmcRTH_Input(). Private DeleteData().

The nType codes coincide with the nType field of the dielectric-node structure sTmcRTHNodeDielOne (see the compute kernel).

---

12. The CTmcRTH_InputNode class — one excitation node

Purpose: stores the instantaneous state of one excitation node. An internal auxiliary class. Header: src/Include/TmcRTH_InputNode.h Depends on: typerth.h.

Fields (private)

Constructor/destructor: CTmcRTH_InputNode(), ~CTmcRTH_InputNode(). There are no other public methods.

---

13. A typical usage scenario

CTmcRTH_Indan cIndan;

// 1. Set the input .tpl and run the preprocessor
cIndan.SetTplFileName( "task.tpl" );
if( cIndan.IsError() ) { /* cIndan.GetErrorMessage() */ }

// 2. Find out the number of steps
int nSteps = cIndan.GetNStepMax();

// 3. Read the data of the desired step
cIndan.ReadData( "task.tpl", 0 );

// 4. Get the parameters, topology, output
CTmcRTH_IndanParam   &p   = cIndan.GetParam();
CTmcRTH_IndanTopology&t   = cIndan.GetTopology();
CTmcRTH_IndanOutput  *out = cIndan.GetOutput();

int nX, nY;  cIndan.GetnXnY( nX, nY );
double delta = cIndan.dGetDelta();

// 5. Traverse the topology blocks
for( CTmcRTH_BlockList *b = t.GetBlockList(); b && b->GetnBlock()!=0; b = b->GetNext() )
{
    int    type    = b->GetnType();      // the type code (eps/metal/absorber/...)
    CString epsExpr = b->GetcsEpsExpr();  // the eps expression
}