orbithunter.RelativeEquilibriumOrbitKS.precondition

RelativeEquilibriumOrbitKS.precondition(**kwargs)

Rescale a vector with the inverse (absolute value) of linear spatial terms

Parameters

kwargs :

pmulttuple of tuples

Parameters passed in the form self.preconditioning_parameters

pexptuple

Exponents for the parameter scaling, default (1, 4)

Returns

targetOrbitKS

Return the OrbitKS instance, whose state and parameters have been modified by preconditioning.

Notes

Often we want to precondition a state derived from a mapping or rmatvec (gradient descent step), with respect to another orbit’s (current state’s) parameters. By passing parameters we can access the cached classmethods.

I never preconditioned the spatial shift for relative periodic solutions so I don’t include it here.