celeritas::CartMapFieldAlongStepFactory Class Reference

Create an along-step method for a three-dimensional (x-y-z in the cartesian coordinate system) map field (CartMapField). More...

#include <AlongStepFactory.hh>

Inheritance diagram for celeritas::CartMapFieldAlongStepFactory:

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

Public Member Functions
	CartMapFieldAlongStepFactory (CartMapFieldFunction f)
	Emit an along-step action with a non-uniform magnetic field.
result_type	operator() (argument_type input) const final
	Emit an along-step action.
CartMapFieldInput	get_field () const
	Get the field params (used for converting to celeritas::inp).

Additional Inherited Members
Protected Member Functions inherited from celeritas::AlongStepFactoryInterface
	CELER_DEFAULT_COPY_MOVE (AlongStepFactoryInterface)

Detailed Description

Create an along-step method for a three-dimensional (x-y-z in the cartesian coordinate system) map field (CartMapField).

Constructor & Destructor Documentation

CartMapFieldAlongStepFactory()

celeritas::CartMapFieldAlongStepFactory::CartMapFieldAlongStepFactory ( CartMapFieldFunction  f )

explicit

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

The action will embed the field propagator with a CartMapField.

Member Function Documentation

operator()()

auto celeritas::CartMapFieldAlongStepFactory::operator() ( argument_type  input ) const

finalvirtual

Emit an along-step action.

Implements celeritas::AlongStepFactoryInterface.

---

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

• AlongStepFactory.hh
• AlongStepFactory.cc