AntisymmetricOrbitKS

Overview

class orbithunter.AntisymmetricOrbitKS(state=None, basis=None, parameters=None, discretization=None, constraints=None, **kwargs)

Methods

Note

See also Orbit and OrbitKS.

Initialization

AntisymmetricOrbitKS.__init__([state, …])	Initialize self.
AntisymmetricOrbitKS.populate([attr])	Initialize random parameters or state or both.
AntisymmetricOrbitKS._populate_state(**kwargs)	Initialize a set of random spatiotemporal Fourier modes
AntisymmetricOrbitKS._populate_parameters(…)	Should only be accessed through Orbit.populate()

Special Methods

“Special” methods also known as “magic” or “dunder” (double underscore) methods account for most basic Math operations and other operations pertaining to NumPy arrays.

Note

See Orbit for all definitions.

Properties

AntisymmetricOrbitKS.shape	Current state array’s shape
AntisymmetricOrbitKS.size	Current state array’s dimensionality
AntisymmetricOrbitKS.ndim	Current state array’s number of dimensions

Discretization and Dimensions

AntisymmetricOrbitKS.shapes()	State array shapes in different bases.
AntisymmetricOrbitKS.dimensions()	Tile dimensions.
AntisymmetricOrbitKS.glue_dimensions(…[, …])	Strategy for combining tile dimensions in gluing; default is arithmetic averaging.
AntisymmetricOrbitKS.dimension_based_discretization(…)	Return discretization size according to orbithunter conventions for the KSe.
AntisymmetricOrbitKS.plotting_dimensions()	Dimensions according to plot labels; used in clipping.

Math Functions

AntisymmetricOrbitKS.orbit_vector()	Vector representation of Orbit instance; constants all variables required to define the Orbit instance.
AntisymmetricOrbitKS.abs()	Orbit instance with absolute value of state.
AntisymmetricOrbitKS.dot(other)	Return the L_2 inner product of two orbits
AntisymmetricOrbitKS.norm([order])	Norm of spatiotemporal state via numpy.linalg.norm
AntisymmetricOrbitKS.dx(**kwargs)	Spatial derivative of the current state.
AntisymmetricOrbitKS.dt([order, array])	Spectral time derivatives of the current state.
AntisymmetricOrbitKS.eqn(**kwargs)	Instance whose state is the Kuramoto-Sivashinsky equation evaluated at the current state
AntisymmetricOrbitKS.matvec(other, **kwargs)	Matrix-vector product of a vector with the Jacobian of the current state.
AntisymmetricOrbitKS.rmatvec(other, **kwargs)	Matrix-vector product with the adjoint of the Jacobian
AntisymmetricOrbitKS.precondition(**kwargs)	Rescale a vector with the inverse (absolute value) of linear spatial terms
AntisymmetricOrbitKS.jacobian(**kwargs)	Jacobian matrix evaluated at the current state.

Visualization

AntisymmetricOrbitKS.plot([show, save, …])	Plot the velocity field as a 2-d density plot using matplotlib’s imshow
AntisymmetricOrbitKS.mode_plot([show, save, …])	Plot the spatiotemporal Fourier spectrum as a 2-d density plot using matplotlib’s imshow

State Transformations

AntisymmetricOrbitKS.transform([to, array, …])	Transform current state to a different basis.
AntisymmetricOrbitKS.resize(…)	Rediscretize the current state typically via zero padding or interpolation.
AntisymmetricOrbitKS.reflection([axis, signed])	Reflect the velocity field about the spatial midpoint
AntisymmetricOrbitKS.roll(shift[, axis])	Apply numpy roll along specified axis.
AntisymmetricOrbitKS.cell_shift(n_cell[, axis])	Rotate by fraction of the period in either axis; nearest discrete approximate is taken.
AntisymmetricOrbitKS.rotate(distance[, …])	Rotate the velocity field in either space or time.
AntisymmetricOrbitKS.shift_reflection()	Return a OrbitKS with shift-reflected velocity field
AntisymmetricOrbitKS.to_fundamental_domain([half])	Overwrite of parent method
AntisymmetricOrbitKS.from_fundamental_domain([half])	Overwrite of parent method
AntisymmetricOrbitKS._pad(size[, axis])	Overwrite of parent method
AntisymmetricOrbitKS._truncate(size[, axis])	Overwrite of parent method

Static

AntisymmetricOrbitKS.bases_labels()	Labels of the different bases produced by transforms.
AntisymmetricOrbitKS.minimal_shape()	The smallest possible compatible discretization to have full functionality.
AntisymmetricOrbitKS.minimal_shape_increments()	The smallest valid increment to change the discretization by.
AntisymmetricOrbitKS.discretization_labels()	Strings to use to label dimensions/periods
AntisymmetricOrbitKS.parameter_labels()	Labels of all parameters
AntisymmetricOrbitKS.dimension_labels()	Strings to use to label dimensions/periods.
AntisymmetricOrbitKS.periodic_dimensions()	Bools indicating whether or not dimension is periodic.
AntisymmetricOrbitKS.positive_indexing()	Indicates whether numpy indexing corresponds to increasing or decreasing values configuration space variable

Other

AntisymmetricOrbitKS.copy()	Return an instance with copies of copy-able attributes.
AntisymmetricOrbitKS.mask(masking_array[, …])	Return an Orbit instance with a numpy masked array state
AntisymmetricOrbitKS.constrain(*labels)	Set self constraints based on labels provided.
AntisymmetricOrbitKS.preprocess()	Check whether the orbit converged to an equilibrium or close-to-zero solution
AntisymmetricOrbitKS.selection_rules()

Defaults

AntisymmetricOrbitKS.defaults()	Dict of default values for constraints, parameter ranges, sizes, etc.
AntisymmetricOrbitKS._default_shape()	The shape of a generic state, see core.py for details
AntisymmetricOrbitKS._default_parameter_ranges()	Default parameter ranges.
AntisymmetricOrbitKS._default_constraints()	Defaults for whether or not parameters are constrained.

Reading and Writing Data

AntisymmetricOrbitKS.filename([extension, …])	Method for convenience and consistent/conventional file naming.
AntisymmetricOrbitKS.to_h5([filename, …])	Export current state information to HDF5 file.