fr.cnes.sirius.patrius.wrenches

Class MagneticWrench

java.lang.Object

fr.cnes.sirius.patrius.wrenches.MagneticWrench

All Implemented Interfaces:

WrenchModel

public class MagneticWrench
extends Object
implements WrenchModel

This class represents a wrench model

Since:

2.1

Version:

$$

Author:

Rami Houdroge

Concurrency :

conditionally thread-safe

Concurrency comment :

thread-safe if the underlying geo magnetic field is also thread-safe

Constructor Summary

Constructors

Constructor and Description
MagneticWrench(MagneticMomentProvider moment, GeoMagneticField field) Constructor

Method Summary

Modifier and Type	Method and Description
Vector3D	computeTorque(SpacecraftState s) Compute the resulting torque at the mass centre of the spacecraft in the frame of the main part.
Vector3D	computeTorque(SpacecraftState s, Vector3D origin, Frame frame) Compute the resulting wrench.
Wrench	computeWrench(SpacecraftState s) Compute the resulting wrench at the mass centre of the spacecraft in the frame of the main part.
Wrench	computeWrench(SpacecraftState s, Vector3D origin, Frame frame) Compute the resulting wrench.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MagneticWrench

public MagneticWrench(MagneticMomentProvider moment,
                      GeoMagneticField field)

Constructor

Parameters:

moment - dipole model of spacecraft expressed in spacecraft frame

field - geomagnetic field

Method Detail

computeWrench

public Wrench computeWrench(SpacecraftState s)
                     throws PatriusException

Compute the resulting wrench at the mass centre of the spacecraft in the frame of the main part.

Specified by:

computeWrench in interface WrenchModel

Parameters:

s - spacecraft state

Returns:

resulting wrench

Throws:

PatriusException - if some error occurs

computeWrench

public Wrench computeWrench(SpacecraftState s,
                            Vector3D origin,
                            Frame frame)
                     throws PatriusException

Compute the resulting wrench.

Specified by:

computeWrench in interface WrenchModel

Parameters:

s - spacecraft state

origin - point in which to express wrench

frame - frame in which point is expressed

Returns:

resulting wrench

Throws:

PatriusException - if some error occurs

computeTorque

public Vector3D computeTorque(SpacecraftState s)
                       throws PatriusException

Compute the resulting torque at the mass centre of the spacecraft in the frame of the main part.

Specified by:

computeTorque in interface WrenchModel

Parameters:

s - spacecraft state

Returns:

resulting torque at center of spacecraft state frame

Throws:

PatriusException - if some error occurs

computeTorque

public Vector3D computeTorque(SpacecraftState s,
                              Vector3D origin,
                              Frame frame)
                       throws PatriusException

Compute the resulting wrench.

Specified by:

computeTorque in interface WrenchModel

Parameters:

s - spacecraft state

origin - point in which to express torque

frame - frame in which point is expressed

Returns:

resulting torque expressed at origin

Throws:

PatriusException - if some error occurs