#include <WsfRungeKuttaOrbitalIntegrator.hpp>

Inheritance diagram for WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >:

[legend]

Collaboration diagram for WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >:

[legend]

Public Types
enum class	ErrorCriterion { cUNKNOWN_CRITERION , cL_INFINITY_NORM , cL_TWO_NORM }
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.

Public Member Functions
	WsfRungeKuttaOrbitalIntegrator ()=default
	WsfRungeKuttaOrbitalIntegrator (const WsfRungeKuttaOrbitalIntegrator &aOther)=default
	~WsfRungeKuttaOrbitalIntegrator () override=default
double	GetTolerance () const
void	SetTolerance (double aTolerance)
unsigned int	GetMaxAdjustmentAttempts () const
void	SetMaxAdjustmentAttempts (unsigned int aMaxAdjustmentAttempts)
double	GetMaxStepSize () const
void	SetMaxStepSize (double aMaxStepSize)
double	GetMinStepSize () const
void	SetMinStepSize (double aMinStepSize)
ErrorCriterion	GetErrorCriterion () const
void	SetErrorCriterion (ErrorCriterion aErrorCriterion)
double	GetInitialStepSize () const
void	SetInitialStepSize (double aInitialStepSize)
bool	ProcessInput (UtInput &aInput) override
ut::OrbitalState	AdvanceToTime (const WsfOrbitalDynamics &aDynamics, const UtCalendar &aFinalTime, const ut::OrbitalState &aInitialState) override
Public Member Functions inherited from WsfOrbitalIntegrator
	WsfOrbitalIntegrator ()=default
	WsfOrbitalIntegrator (const WsfOrbitalIntegrator &aOther)
	~WsfOrbitalIntegrator () override=default
WsfOrbitalIntegrator &	operator= (const WsfOrbitalIntegrator &aOther)=delete
WsfOrbitalIntegrator *	Clone () const override=0
const char *	GetScriptClassName () const override
virtual std::string	GetIntegratorType () const =0
void	SetPropagator (const WsfIntegratingPropagator *aPropagatorPtr)
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)

Static Public Member Functions
static std::string	GetStringFromCriterion (ErrorCriterion aErrorCriterion)
static ErrorCriterion	GetErrorCriterionFromString (const std::string &aErrorCriterion)

Static Public Attributes
static constexpr unsigned int	cORDER = Order
static constexpr unsigned int	cSTEPCOUNT = StepCount

Additional Inherited Members
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).
Protected Attributes inherited from WsfOrbitalIntegrator
const WsfIntegratingPropagator *	mPropagatorPtr {nullptr}

Member Enumeration Documentation

◆ ErrorCriterion

template<unsigned int Order, unsigned int StepCount, typename Integrator>

enum class WsfRungeKuttaOrbitalIntegrator::ErrorCriterion

strong

Enumerator
cUNKNOWN_CRITERION
cL_INFINITY_NORM
cL_TWO_NORM

Constructor & Destructor Documentation

◆ WsfRungeKuttaOrbitalIntegrator() [1/2]

template<unsigned int Order, unsigned int StepCount, typename Integrator>

WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::WsfRungeKuttaOrbitalIntegrator ( )

default

Referenced by WsfRungeKuttaOrbitalIntegrator().

◆ WsfRungeKuttaOrbitalIntegrator() [2/2]

template<unsigned int Order, unsigned int StepCount, typename Integrator>

WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::WsfRungeKuttaOrbitalIntegrator ( const WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator > & aOther )

default

References WsfRungeKuttaOrbitalIntegrator().

◆ ~WsfRungeKuttaOrbitalIntegrator()

template<unsigned int Order, unsigned int StepCount, typename Integrator>

WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::~WsfRungeKuttaOrbitalIntegrator ( )

overridedefault

Member Function Documentation

◆ AdvanceToTime()

template<unsigned int Order, unsigned int StepCount, typename Integrator>

ut::OrbitalState WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::AdvanceToTime	(	const WsfOrbitalDynamics &	aDynamics,
		const UtCalendar &	aFinalTime,
		const ut::OrbitalState &	aInitialState )

inlineoverridevirtual

Implements WsfOrbitalIntegrator.

◆ GetErrorCriterion()

template<unsigned int Order, unsigned int StepCount, typename Integrator>

ErrorCriterion WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::GetErrorCriterion ( ) const

inline

◆ GetErrorCriterionFromString()

template<unsigned int Order, unsigned int StepCount, typename Integrator>

ErrorCriterion WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::GetErrorCriterionFromString ( const std::string & aErrorCriterion )

inlinestatic

References cL_INFINITY_NORM, cL_TWO_NORM, and cUNKNOWN_CRITERION.

Referenced by ProcessInput().

◆ GetInitialStepSize()

template<unsigned int Order, unsigned int StepCount, typename Integrator>

double WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::GetInitialStepSize ( ) const

inline

◆ GetMaxAdjustmentAttempts()

template<unsigned int Order, unsigned int StepCount, typename Integrator>

unsigned int WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::GetMaxAdjustmentAttempts ( ) const

inline

◆ GetMaxStepSize()

template<unsigned int Order, unsigned int StepCount, typename Integrator>

double WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::GetMaxStepSize ( ) const

inline

◆ GetMinStepSize()

template<unsigned int Order, unsigned int StepCount, typename Integrator>

double WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::GetMinStepSize ( ) const

inline

◆ GetStringFromCriterion()

template<unsigned int Order, unsigned int StepCount, typename Integrator>

std::string WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::GetStringFromCriterion ( ErrorCriterion aErrorCriterion )

inlinestatic

References cL_INFINITY_NORM, cL_TWO_NORM, and cUNKNOWN_CRITERION.

◆ GetTolerance()

template<unsigned int Order, unsigned int StepCount, typename Integrator>

double WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::GetTolerance ( ) const

inline

◆ ProcessInput()

template<unsigned int Order, unsigned int StepCount, typename Integrator>

bool WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::ProcessInput ( UtInput & aInput )

inlineoverridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters

aInput a reference to a UtInput object.

Returns: 'true' if the command was one recognized by the class or 'false' if not.

Exceptions

UtInput::ExceptionBase (or an object derived from it) if the command was recognized but contains some sort of error.

Note: If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from WsfObject.

References cUNKNOWN_CRITERION, and GetErrorCriterionFromString().

◆ SetErrorCriterion()

template<unsigned int Order, unsigned int StepCount, typename Integrator>

void WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::SetErrorCriterion ( ErrorCriterion aErrorCriterion )

inline

◆ SetInitialStepSize()

template<unsigned int Order, unsigned int StepCount, typename Integrator>

void WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::SetInitialStepSize ( double aInitialStepSize )

inline

◆ SetMaxAdjustmentAttempts()

template<unsigned int Order, unsigned int StepCount, typename Integrator>

void WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::SetMaxAdjustmentAttempts ( unsigned int aMaxAdjustmentAttempts )

inline

◆ SetMaxStepSize()

template<unsigned int Order, unsigned int StepCount, typename Integrator>

void WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::SetMaxStepSize ( double aMaxStepSize )

inline

◆ SetMinStepSize()

template<unsigned int Order, unsigned int StepCount, typename Integrator>

void WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::SetMinStepSize ( double aMinStepSize )

inline

◆ SetTolerance()

template<unsigned int Order, unsigned int StepCount, typename Integrator>

void WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::SetTolerance ( double aTolerance )

inline

Referenced by UT_DEFINE_SCRIPT_METHOD(), and UT_DEFINE_SCRIPT_METHOD().

Member Data Documentation

◆ cORDER

template<unsigned int Order, unsigned int StepCount, typename Integrator>

unsigned int WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::cORDER = Order

staticconstexpr

◆ cSTEPCOUNT

template<unsigned int Order, unsigned int StepCount, typename Integrator>

unsigned int WsfRungeKuttaOrbitalIntegrator< Order, StepCount, Integrator >::cSTEPCOUNT = StepCount

staticconstexpr

The documentation for this class was generated from the following file:

WsfRungeKuttaOrbitalIntegrator.hpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ ErrorCriterion

Constructor & Destructor Documentation

◆ WsfRungeKuttaOrbitalIntegrator() [1/2]

◆ WsfRungeKuttaOrbitalIntegrator() [2/2]

◆ ~WsfRungeKuttaOrbitalIntegrator()

Member Function Documentation

◆ AdvanceToTime()

◆ GetErrorCriterion()

◆ GetErrorCriterionFromString()

◆ GetInitialStepSize()

◆ GetMaxAdjustmentAttempts()

◆ GetMaxStepSize()

◆ GetMinStepSize()

◆ GetStringFromCriterion()

◆ GetTolerance()

◆ ProcessInput()

◆ SetErrorCriterion()

◆ SetInitialStepSize()

◆ SetMaxAdjustmentAttempts()

◆ SetMaxStepSize()

◆ SetMinStepSize()

◆ SetTolerance()

Member Data Documentation

◆ cORDER

◆ cSTEPCOUNT