Stellarator-Tools Documentation

Table of Contents

• Introduction
• User manuals
  • Model Manual.
  • Equilibrium manuals.
    • VMEC Equilibrium manuals.
    • Vacuum Equilibrium manuals.
    • SIESTA Equilibrium manuals.
  • Diagnostic input files.
    • V3RFUN manual.
    • LGIRD manual.
• Programmer Manuals

Introduction

This documentation combines end user and developer documentation into a single reference. The code for Stellarator-Tools is hosted on GitHub.

User manuals

These manuals cover topics for end users on how to operate V3FIT.

• Command Line Arguments Descritptions of the command line arguments.
• V3FIT namelist input file User manual for the V3FIT namelist input file.
• Result output file. User manual for the result NetCDF file.

Model Manual.

• Model Manual User manual for the V3FIT model.
• Emission File Manual User manual for the Soft X-ray emission file.

Equilibrium manuals.

V3FIT is designed to support many different equilibrium solvers. Currently implemented are two. The VMEC solver and a Vacuum solver.

VMEC Equilibrium manuals.

• VMEC Wiki Information about the VMEC code.
• VMEC Equilibrium Manual User manual for the VMEC equilibrium.

Vacuum Equilibrium manuals.

• Vacuum Equilibrium Manual User manual for the Vacuum equilibrium.
• Vacuum namelist input file. User manual for the vacuum equilibrium namelist input file.

SIESTA Equilibrium manuals.

• SIESTA Equilibrium Manual User manual for the SIESTA equilibrium.
• SIESTA namelist input file User manual for the SIESTA namelist input file.
• SIESTA restart file. User manual for the SIESTA restart file.

Diagnostic input files.

Certain diagnostics require input files to describe the diagnostic. Below are documentation for the various files needed to define diagnostics.

• Soft X-ray Diagnostic Dot File User manual for the soft x-ray diagnostic dot file.
• Inteferometry/Polarimetry Diagnostic Dot File User manual for the inteferometry/polarimetry diagnostic dot file.
• Thomson Scattering Diagnostic Dot File User manual for the Thomson scattering diagnostic dot file.
• Motional Stark Effect Diagnostic Dot File User manual for the motional stark effect diagnostic dot file.
• ECE Diagnostic Dot File User manual for the ECE diagnostic dot file.
• Soft X-ray Ratio Diagnostic Dot File User manual for the soft x-ray ratio diagnostic dot file.

V3RFUN manual.

Magnetic diagnostics require a preprocessing code V3RFUN to generate the input discription files.

• Magnetic Diagnostic Dot File User manual for the magnetic diagnostic dot file.
• V3RFUN namelist input file User manual for the V3RFUN namelist input file.
• V3RFUN Command Line Arguments User manual for the V3RFUN command line arguments.

LGIRD manual.

Limiter grids require a preprocessing code LGRID to generate the input discription file.

• LGRID User Documentation. User manual for the LGIRD code.

Programmer Manuals

These manuals are meant to document the various tools and structure used by V3FIT. Reading these pages is not necessary for the operation of V3FIT.

• Build System Programming manual for the build system using CMake.
• Doxygen Manual for the generation of documentation.
• V3FIT Architecture Programming manual overviewing the design of v3fit.
• V3FIT Class Anatomy Programming manual describing the structure of class objects.
• Testing Programming manual describing the testing framework.