Manual.html

<HTML>
<HEAD>
<TITLE>OpenEdge Users Manual</TITLE>
<META NAME="docnumber" CONTENT="version 26.04 (Sep 2026)">
<META NAME="author" CONTENT="https://github.com/ORNL-Fusion/OpenEdge - Oak Ridge National Laboratory">
<META NAME="copyright" CONTENT="Distributed under the GNU General Public License v2. Built on SPARTA, Copyright (2014) Sandia Corporation.">
</HEAD>

<BODY>

<CENTER><A HREF = "https://github.com/ORNL-Fusion/OpenEdge">OpenEdge WWW Site</A> - <A HREF = "Manual.html">OpenEdge Documentation</A> - <A HREF = "Section_commands.html#comm">OpenEdge Commands</A> 
</CENTER>






<HR>

<H1></H1>

<CENTER><H3>OpenEdge Documentation 
</H3></CENTER>
<CENTER><H4>version 26.04 (Sep 2026) 
</H4></CENTER>
<H4>Version info: 
</H4>
<P>The OpenEdge version is the git tag of the release, such as 26.04,
printed to the screen and log file at the start of every run and shown
at the top of this page.  Development builds append the number of
commits since the tag and the commit hash, as reported by "git
describe".
</P>
<UL><LI>If you browse the HTML pages in the doc directory of your checkout,
they describe the version you have. 

<LI>The <A HREF = "Manual.pdf">PDF file</A> in the doc directory is regenerated at each
release. 
</UL>
<P>OpenEdge is a kinetic transport code for the plasma edge and for
plasma-material interaction.  It follows neutral atoms and molecules,
impurity ions, and dust or droplet particulates through prescribed
plasma and magnetic-field backgrounds taken from edge fluid codes such
as SOLPS-ITER, SOLEDGE3X, OEDGE and EMC3-EIRENE.  Particles are pushed
with Boris or guiding-center integrators, undergo ADAS atomic
processes, Coulomb collisions and cross-field transport, and interact
with the wall through sputtering, reflection, recycling and evolving
surface composition.
</P>
<P>OpenEdge is built on <A HREF = "https://sparta.github.io">SPARTA</A>, the Direct Simulation Monte Carlo
code developed at Sandia National Laboratories.  SPARTA provides the
hierarchical Cartesian grid, cut-cell surfaces, particle storage, MPI
parallelism and the Kokkos performance-portability layer.  The input
language documented here is SPARTA's, extended with OpenEdge commands
and styles.  OpenEdge is developed at Oak Ridge National Laboratory and
is distributed under the GNU General Public License version 2, the
same license as SPARTA.
</P>


<HR>

<P>The OpenEdge documentation is organized into the following sections.
If you find errors or omissions in this manual, please open an issue on
the <A HREF = "https://github.com/ORNL-Fusion/OpenEdge">OpenEdge repository</A>.
</P>
<P>Once you are familiar with OpenEdge, you may want to bookmark <A HREF = "Section_commands.html#comm">this
page</A> since it gives quick access to the
documentation for every command.
</P>
<P><A HREF = "Manual.pdf">PDF file</A> of the entire manual, generated by
<A HREF = "http://www.easysw.com/htmldoc">htmldoc</A>
</P>
<OL><LI><A HREF = "Section_intro.html">Introduction</A> 

<UL>  1.1 <A HREF = "Section_intro.html#intro_1">What is OpenEdge</A> 
<BR>
  1.2 <A HREF = "Section_intro.html#intro_2">OpenEdge features</A> 
<BR>
  1.3 <A HREF = "Section_intro.html#intro_3">Grids, surfaces and plasma backgrounds</A> 
<BR>
  1.4 <A HREF = "Section_intro.html#intro_4">Open source distribution</A> 
<BR>
  1.5 <A HREF = "Section_intro.html#intro_5">Acknowledgments and citations</A> 
<BR></UL>
<LI><A HREF = "Section_start.html">Getting started</A> 

<UL>  2.1 <A HREF = "Section_start.html#start_1">What's in the OpenEdge distribution</A> 
<BR>
  2.2 <A HREF = "Section_start.html#start_2">Building OpenEdge</A> 
<BR>
  2.3 <A HREF = "Section_start.html#start_3">Testing OpenEdge</A> 
<BR>
  2.4 <A HREF = "Section_start.html#start_4">Running OpenEdge</A> 
<BR>
  2.5 <A HREF = "Section_start.html#start_5">Command-line options</A> 
<BR>
  2.6 <A HREF = "Section_start.html#start_6">Screen output</A> 
<BR></UL>
<LI><A HREF = "Section_commands.html">Commands</A> 

<UL>  3.1 <A HREF = "Section_commands.html#cmd_1">OpenEdge input script</A> 
<BR>
  3.2 <A HREF = "Section_commands.html#cmd_2">Parsing rules</A> 
<BR>
  3.3 <A HREF = "Section_commands.html#cmd_3">Input script structure</A> 
<BR>
  3.4 <A HREF = "Section_commands.html#cmd_4">Commands listed by category</A> 
<BR>
  3.5 <A HREF = "Section_commands.html#cmd_5">Commands listed alphabetically</A> 
<BR></UL>
<LI><A HREF = "Section_howto.html">How-to discussions</A> 

<UL>  4.1 <A HREF = "Section_howto.html#howto_1">2d simulations</A> 
<BR>
  4.2 <A HREF = "Section_howto.html#howto_2">Axisymmetric simulations</A> 
<BR>
  4.3 <A HREF = "Section_howto.html#howto_3">Plasma and magnetic-field backgrounds</A> 
<BR>
  4.4 <A HREF = "Section_howto.html#howto_4">The plasma.h5 file</A> 
<BR>
  4.5 <A HREF = "Section_howto.html#howto_5">Wall geometry and surface normals</A> 
<BR>
  4.6 <A HREF = "Section_howto.html#howto_6">The processes.h5 database</A> 
<BR>
  4.7 <A HREF = "Section_howto.html#howto_7">Running multiple simulations from one input script</A> 
<BR>
  4.8 <A HREF = "Section_howto.html#howto_8">Output from OpenEdge</A> 
<BR>
  4.9 <A HREF = "Section_howto.html#howto_9">Visualizing snapshots</A> 
<BR>
  4.10 <A HREF = "Section_howto.html#howto_10">Details of grid geometry</A> 
<BR>
  4.11 <A HREF = "Section_howto.html#howto_11">Details of surfaces</A> 
<BR>
  4.12 <A HREF = "Section_howto.html#howto_12">Restarting a simulation</A> 
<BR>
  4.13 <A HREF = "Section_howto.html#howto_13">Visualizing output with ParaView</A> 
<BR>
  4.14 <A HREF = "Section_howto.html#howto_14">Custom per-particle, per-grid, per-surf attributes</A> 
<BR>
  4.15 <A HREF = "Section_howto.html#howto_15">Variable timestep simulations</A> 
<BR></UL>
<LI><A HREF = "Section_example.html">Example problems</A> 

<LI><A HREF = "Section_errors.html">Errors</A> 

<UL>  6.1 <A HREF = "Section_errors.html#err_1">Common problems</A> 
<BR>
  6.2 <A HREF = "Section_errors.html#err_2">Reporting bugs</A> 
<BR>
  6.3 <A HREF = "Section_errors.html#err_3">Error & warning messages</A> 
<BR></UL>

</OL>




































































</BODY>

<!-- PAGE BREAK -->
</HTML>