package
0.0.0-20231020172443-6a04e573c552
Repository: https://github.com/felixdux/imposcg.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetParameterGroups godoc @Summary Parameter groups @Description Groups for displaying related parameters @ID get-parameter-groups @Produce json @Success 200 {object} controllers.ParameterInfo @Router /parameter-info/groups/ [get].
GetParameterSymbols godoc @Summary Parameter symbols @Description Greek symbols to be used for rendering specified parameters @ID get-parameter-symbols @Produce json @Success 200 {object} controllers.ParameterInfo @Router /parameter-info/symbols/ [get].
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PostDOAData godoc @Summary Domain of attraction data @Description Return domains of attraction for the impact map for a specified set of parameters @ID post-doa-data @Accept x-www-form-urlencoded @Produce json @Param frequency formData number true "Forcing frequency" minimum(0) @Param offset formData number true "Obstacle offset from origin" @Param r formData number true "Coefficient of restitution" minimum(0) maximum(1) @Param maxPeriods formData int false "Number of periods without an impact after which the algorithm will report 'long excursions'" default(100) @Param numIterations formData int false "Number of iterations of impact map" default(500) @Param maxVelocity formData number true "Upper limit of impact velocity range for DOA plot" default(4.0) @Param numPhases formData int false "Size of grid along the φ-axis" default(100) @Param numVelocities formData int false "Size of grid along the v-axis" default(100) @Success 200 {object} dynamics.IterationResult @Failure 400 {object} string "Invalid parameters" @Router /doa/data/ [post].
PostDOAImage godoc @Summary Domain of attraction plot @Description Plot domains of attraction for the impact map for a specified set of parameters @ID post-doa-image @Accept x-www-form-urlencoded @Produce png @Param frequency formData number true "Forcing frequency" minimum(0) @Param offset formData number true "Obstacle offset from origin" @Param r formData number true "Coefficient of restitution" minimum(0) maximum(1) @Param maxPeriods formData int false "Number of periods without an impact after which the algorithm will report 'long excursions'" default(100) @Param numIterations formData int false "Number of iterations of impact map" default(500) @Param maxVelocity formData number true "Upper limit of impact velocity range for DOA plot" default(4.0) @Param numPhases formData int false "Size of grid along the φ-axis" default(100) @Param numVelocities formData int false "Size of grid along the v-axis" default(100) @Success 200 {object} dynamics.IterationResult @Failure 400 {object} string "Invalid parameters" @Router /doa/image/ [post].
PostIterationData godoc @Summary Impact data @Description Return data from iterating the impact map for a specified set of parameters @ID post-iteration-data @Accept x-www-form-urlencoded @Produce json @Param frequency formData number true "Forcing frequency" minimum(0) @Param offset formData number true "Obstacle offset from origin" @Param r formData number true "Coefficient of restitution" minimum(0) maximum(1) @Param maxPeriods formData int false "Number of periods without an impact after which the algorithm will report 'long excursions'" default(100) @Param phi formData number true "Phase at initial impact" default(0.0) @Param v formData number true "Velocity at initial impact" default(0.0) @Param numIterations formData int false "Number of iterations of impact map" default(5000) @Success 200 {object} dynamics.IterationResult @Failure 400 {object} string "Invalid parameters" @Router /iteration/data/ [post].
PostIterationImage godoc @Summary Impact map @Description Return scatter plot from iterating the impact map for a specified set of parameters @ID post-iteration-image @Accept x-www-form-urlencoded @Produce png @Param frequency formData number true "Forcing frequency" minimum(0) @Param offset formData number true "Obstacle offset from origin" @Param r formData number true "Coefficient of restitution" minimum(0) maximum(1) @Param maxPeriods formData int false "Number of periods without an impact after which the algorithm will report 'long excursions'" default(100) @Param phi formData number true "Phase at initial impact" default(0.0) @Param v formData number true "Velocity at initial impact" default(0.0) @Param numIterations formData int false "Number of iterations of impact map" default(5000) @Success 200 {object} dynamics.IterationResult @Failure 400 {object} string "Invalid parameters" @Router /iteration/image/ [post].
PostSingularitySetData godoc @Summary Singularity set data @Description Return impacts which map to and from zero velocity impacts for a specified set of parameters @ID post-singularity-set-data @Accept x-www-form-urlencoded @Produce json @Param frequency formData number true "Forcing frequency" minimum(0) @Param offset formData number true "Obstacle offset from origin" @Param r formData number true "Coefficient of restitution" minimum(0) maximum(1) @Param maxPeriods formData int false "Number of periods without an impact after which the algorithm will report 'long excursions'" default(100) @Param numPoints formData int false "Number of impacts to map" default(5000) @Success 200 {object} dynamics.IterationResult @Failure 400 {object} string "Invalid parameters" @Router /singularity-set/data/ [post].
PostSingularitySetImage godoc @Summary Singularity set @Description Return scatter plot of impacts which map to and from zero velocity impacts for a specified set of parameters @ID post-singularity-set-image @Accept x-www-form-urlencoded @Produce png @Param frequency formData number true "Forcing frequency" minimum(0) @Param offset formData number true "Obstacle offset from origin" @Param r formData number true "Coefficient of restitution" minimum(0) maximum(1) @Param maxPeriods formData int false "Number of periods without an impact after which the algorithm will report 'long excursions'" default(100) @Param numPoints formData int false "Number of impacts to map" default(5000) @Success 200 {object} dynamics.IterationResult @Failure 400 {object} string "Invalid parameters" @Router /singularity-set/image/ [post].
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author