Skip to content

Commit d3d5378

Browse files
committed
Update docs
1 parent 36aac55 commit d3d5378

File tree

4 files changed

+28
-7
lines changed

4 files changed

+28
-7
lines changed

doc/implementation/core-physics/stepping.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,9 @@ single "action" class can, for example, allocate states at the beginning of the
5858
run and execute once per step.
5959

6060
There are currently two different actions that act as extension points to the
61-
stepping loop: :cpp:class:`BeginRunActionInterface` is called once per event
62-
(or set of simultaneously initialized events), and :cpp:class:`StepActionInterface`
61+
stepping loop: :cpp:class:`celeritas::BeginRunActionInterface` is called once
62+
per event
63+
(or set of simultaneously initialized events), and :cpp:class:`celeritas::StepActionInterface`
6364
is called once per step, ordered using :cpp:enum:`celeritas::StepActionOrder`.
6465

6566
.. doxygenclass:: celeritas::ActionInterface

doc/implementation/corecel.rst

+15
Original file line numberDiff line numberDiff line change
@@ -89,15 +89,30 @@ incorrect configuration or input values.
8989
System
9090
------
9191

92+
The system subdirectory provides uniform interfaces to hardware and the
93+
operating system.
94+
95+
GPU management
96+
^^^^^^^^^^^^^^
97+
9298
.. doxygenclass:: celeritas::Device
9399
.. doxygenfunction:: celeritas::device
94100
.. doxygenfunction:: celeritas::activate_device()
95101

102+
Environment variables
103+
^^^^^^^^^^^^^^^^^^^^^
104+
96105
.. doxygenclass:: celeritas::Environment
97106
.. doxygenfunction:: celeritas::environment
98107
.. doxygenfunction:: celeritas::getenv
99108
.. doxygenfunction:: celeritas::getenv_flag
100109

110+
MPI support
111+
^^^^^^^^^^^
112+
113+
.. doxygenclass:: celeritas::ScopedMpi
114+
.. doxygenclass:: celeritas::MpiCommunicator
115+
101116
Utility functions
102117
-----------------
103118

doc/implementation/geant4-interface.rst

+9-4
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ advanced implementation can be inspected in the :ref:`celer-g4` app.
1717
High level interfaces
1818
---------------------
1919

20+
The high-level integration classes are the easiest way to add Celeritas to a
21+
Geant4 application. Under the hood, it contains a singleton class instance that
22+
sets up the UI commands (see :cpp:class:`celeritas::SetupOptionsMessenger`),
23+
MPI (if configured), and Celeritas logging.
24+
2025
.. doxygenclass:: celeritas::IntegrationBase
2126
:members:
2227
:no-link:
@@ -31,7 +36,7 @@ manager correctly, we recommend using this helper class:
3136

3237
.. doxygenclass:: celeritas::TrackingManagerConstructor
3338

34-
The high-level :cpp:class:`TrackingManagerIntegration` class should be used in
39+
The high-level :cpp:class:`celeritas::TrackingManagerIntegration` class should be used in
3540
addition to the tracking manager constructor to set up and tear down Celeritas.
3641
See :ref:`example_template` for a template of adding to a user application.
3742

@@ -114,9 +119,9 @@ compatible with Celeritas), the Celeritas setup will fail with an error like:
114119
.. doxygenclass:: celeritas::RZMapFieldAlongStepFactory
115120

116121

117-
The :cpp:class:`SetupOptionsMessenger`, instantiated automatically by the
118-
Integration helper classes, provides a Geant4 "UI" macro interface to many of
119-
the options.
122+
The :cpp:class:`celeritas::SetupOptionsMessenger`, instantiated automatically
123+
by the Integration helper classes, provides a Geant4 "UI" macro interface to
124+
many of the options.
120125

121126
.. doxygenclass:: celeritas::SetupOptionsMessenger
122127

doc/implementation/orange.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Intersect region
2222
^^^^^^^^^^^^^^^^
2323

2424
The lowest level primitive for construction is the "intersect region," which is
25-
a CSG intersection of half-spaces. The :cpp:class:`IntersectRegion` interface
25+
a CSG intersection of half-spaces. The IntersectRegion interface
2626
helps construct these objects.
2727

2828
.. doxygenclass:: celeritas::orangeinp::IntersectRegionInterface

0 commit comments

Comments
 (0)