Skip to content

Beam Monitor: Output Name #330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ax3l merged 1 commit into from
Apr 3, 2023
Merged

Beam Monitor: Output Name #330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/source/usage/parameters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,9 +354,14 @@ Lattice Elements

= c parameter * sqrt(Twiss beta)

* ``BeamMonitor`` a beam monitor, writing all beam particles at fixed ``s`` to openPMD files.
* ``beam_monitor`` a beam monitor, writing all beam particles at fixed ``s`` to openPMD files.
If the same element name is used multiple times, then an output series is created with multiple outputs.

* ``<element_name>.name`` (``string``, default value: ``<element_name>``)

The output series name to use.
By default, output is created under ``diags/openPMD/<element_name>.<backend>``.

* ``<element_name>.backend`` (``string``, default value: ``default``)

`I/O backend <https://openpmd-api.readthedocs.io/en/latest/backends/overview.html>`_ for `openPMD <https://www.openPMD.org>`_ data dumps.
Expand Down
4 changes: 3 additions & 1 deletion src/initialization/InitElement.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,11 +180,13 @@ namespace detail
detail::queryAddResize(pp_element, "sin_coefficients", sin_coef);
m_lattice.emplace_back( SoftQuadrupole(ds, gscale, cos_coef, sin_coef, mapsteps, nslice) );
} else if (element_type == "beam_monitor") {
std::string openpmd_name = element_name;
pp_element.queryAdd("name", openpmd_name);
std::string openpmd_backend = "default";
pp_element.queryAdd("backend", openpmd_backend);
std::string openpmd_encoding {"g"};
pp_element.queryAdd("encoding", openpmd_encoding);
m_lattice.emplace_back( diagnostics::BeamMonitor(element_name, openpmd_backend, openpmd_encoding) );
m_lattice.emplace_back( diagnostics::BeamMonitor(openpmd_name, openpmd_backend, openpmd_encoding) );
} else {
amrex::Abort("Unknown type for lattice element " + element_name + ": " + element_type);
}
Expand Down