Celeritas  0.5.0-86+4a8eea4
Public Member Functions | List of all members
celeritas::RZMapFieldAlongStepFactory Class Referencefinal

Create an along-step method for a two-dimensional (r-z in the cylindical coordinate system) map field (RZMapField). More...

#include <AlongStepFactory.hh>

Inheritance diagram for celeritas::RZMapFieldAlongStepFactory:
Inheritance graph
[legend]

Public Types

Type aliases
using RZMapFieldFunction = std::function< RZMapFieldInput()>
 
- Public Types inherited from celeritas::AlongStepFactoryInterface
using argument_type = AlongStepFactoryInput const &
 
using result_type = std::shared_ptr< CoreStepActionInterface const >
 

Public Member Functions

 RZMapFieldAlongStepFactory (RZMapFieldFunction f)
 Emit an along-step action with a non-uniform magnetic field. More...
 
result_type operator() (argument_type input) const final
 

Additional Inherited Members

- Protected Member Functions inherited from celeritas::AlongStepFactoryInterface
 CELER_DEFAULT_COPY_MOVE (AlongStepFactoryInterface)
 

Detailed Description

Create an along-step method for a two-dimensional (r-z in the cylindical coordinate system) map field (RZMapField).

Constructor & Destructor Documentation

◆ RZMapFieldAlongStepFactory()

celeritas::RZMapFieldAlongStepFactory::RZMapFieldAlongStepFactory ( RZMapFieldFunction  f)
explicit

Emit an along-step action with a non-uniform magnetic field.

The action will embed the field propagator with a RZMapField.


The documentation for this class was generated from the following files: