Uses of Package
simpa.core.api

Packages that use simpa.core.api

Package	Description
simpa.acc.api	This package contains the public interfaces and classes of the simpa.acc library.
simpa.acc.api.create	This package contains all the interfaces and classes related to the creation and setting up of components to construct accelerators.
simpa.acc.api.match	This package contains all the interfaces and classes related to optics matching or any other optimization which is performed by tracking beams or particles.
simpa.acc.api.utils	This package contains utility classes to help in using the simpa.acc module.
simpa.core.api	This package contains all public interfaces and classes that can be programmed to.
simpa.core.api.track	This package contains the code related to tracking particles in SIMPA.
simpa.core.api.utils	This package contains all utils that can be used to set up the SIMPA Core library.

Classes in simpa.core.api used by simpa.acc.api

Class	Description
PotentialProvider	Accessible interface for PotentialProviders.
Profile	Object that represents a profile of the shape of the beam region.
TilingConfig	Object that holds the configuration for tiling.

Classes in simpa.core.api used by simpa.acc.api.create

Class	Description
ExtrudedSurface	Represents a surface extruded along a path.
PointSource	Accessible interface for PointSources.
PotentialProvider	Accessible interface for PotentialProviders.
Profile	Object that represents a profile of the shape of the beam region.
SourceArrangement	Class that contains a list of PointSource objects that make up a SourceArrangement.
SphereCovering	Interface with factory methods for creating different SphereCovering implementations.
TangentVector3D	Object representing vector that is tangent to a curve or surface at a given point.

Classes in simpa.core.api used by simpa.acc.api.match

Class	Description
PotentialProvider	Accessible interface for PotentialProviders.

Classes in simpa.core.api used by simpa.acc.api.utils

Class	Description
PotentialProvider	Accessible interface for PotentialProviders.

Classes in simpa.core.api used by simpa.core.api

Class	Description
CoverType	Type of SphereCovering
CurrentLoop	Current loop.
FieldMap	This class represents an electro-magnetic field.
FieldType	Enum for the type of field.
GlobalSourceArrangement	Class containing the source arrangements that make up a region of the field that will be evaluated.
LengthUnit	Enum for LengthUnit and their factor.
OutputFileFormat	Enum for some output files.
PointSource	Accessible interface for PointSources.
PotentialProvider	Accessible interface for PotentialProviders.
Profile	Object that represents a profile of the shape of the beam region.
Quadrature	Enum to specify the quadratura to be used for tiles on the boundary surface.
SHCombiner	Singleton pattern class that combines the SHField with a map of scalings and can serialize and deserialize the SHField to a file.
SolverOptions
SolverOptions.Preconditioner
SolverOptions.SolverType
SourceArrangement	Class that contains a list of PointSource objects that make up a SourceArrangement.
SphereCovering	Interface with factory methods for creating different SphereCovering implementations.
SphereDescripton	Class that describes a single sphere.
SurfacePoint	Accessible interface for SurfacePoint.
TilingConfig	Object that holds the configuration for tiling.

Classes in simpa.core.api used by simpa.core.api.track

Class	Description
PotentialProvider	Accessible interface for PotentialProviders.

Classes in simpa.core.api used by simpa.core.api.utils

Class	Description
LengthUnit	Enum for LengthUnit and their factor.
PointSource	Accessible interface for PointSources.
PotentialProvider	Accessible interface for PotentialProviders.
Profile	Object that represents a profile of the shape of the beam region.
TangentVector3D	Object representing vector that is tangent to a curve or surface at a given point.