celeritas::CylMapFieldAlongStepFactory Class Reference

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

#include <AlongStepFactory.hh>

Inheritance diagram for celeritas::CylMapFieldAlongStepFactory:

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

Public Member Functions
	CylMapFieldAlongStepFactory (CylMapFieldFunction 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.
CylMapFieldInput	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 (r-phi-z in the cylindical coordinate system) map field (CylMapField).

Constructor & Destructor Documentation

CylMapFieldAlongStepFactory()

celeritas::CylMapFieldAlongStepFactory::CylMapFieldAlongStepFactory ( CylMapFieldFunction  f )

explicit

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

The action will embed the field propagator with a CylMapField.

Member Function Documentation

operator()()

auto celeritas::CylMapFieldAlongStepFactory::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