Module simpa.acc

Package simpa.acc.api

Enum Class PlotTypeOption

java.lang.Object

java.lang.Enum<PlotTypeOption>

simpa.acc.api.PlotTypeOption

All Implemented Interfaces:

Serializable, Comparable<PlotTypeOption>, Constable

public enum PlotTypeOption
extends Enum<PlotTypeOption>

Plot type options used by the `plot` CLI command.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ELEMENT_FIELD_CHECK_GP	Launch a gnuplot check script to inspect element field at check points.
FIELD_AT_POINTS_GP	Plots the input (from CAD usually) vector field at quadrature points using GnuPlot.
OPTICS_GP	Launch a gnuplot script to plot optical functions from a TWISS file.
SEQUENCE_SOURCES_PW	Plots the sources in the active sequence in 3D using ParaView
SURFACE_POINTS_PW	Plots the quadrature points on the boundary surface of an element in 3D using ParaView.
TRAJECTORY_PW	Plots the trajectory of a particle in 3D using ParaView

Method Summary

Modifier and Type	Method	Description
static PlotTypeOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PlotTypeOption[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SEQUENCE_SOURCES_PW

public static final PlotTypeOption SEQUENCE_SOURCES_PW

Plots the sources in the active sequence in 3D using ParaView

TRAJECTORY_PW

public static final PlotTypeOption TRAJECTORY_PW

Plots the trajectory of a particle in 3D using ParaView

SURFACE_POINTS_PW

public static final PlotTypeOption SURFACE_POINTS_PW

Plots the quadrature points on the boundary surface of an element in 3D using ParaView. These are the points where the fields will be read from OPERA3D, COMSOL, or other field calculation software.

FIELD_AT_POINTS_GP

public static final PlotTypeOption FIELD_AT_POINTS_GP

Plots the input (from CAD usually) vector field at quadrature points using GnuPlot.

ELEMENT_FIELD_CHECK_GP

public static final PlotTypeOption ELEMENT_FIELD_CHECK_GP

Launch a gnuplot check script to inspect element field at check points.

OPTICS_GP

public static final PlotTypeOption OPTICS_GP

Launch a gnuplot script to plot optical functions from a TWISS file.

Method Details

values

public static PlotTypeOption[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PlotTypeOption valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null