MagneticCoilTorqueCreateMagneticCoilTorqueUsingIgrfTxtModel Method |
Namespace:
AGI.Foundation.Celestial
Assembly:
AGI.Foundation.OrbitPropagation (in AGI.Foundation.OrbitPropagation.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax public static MagneticCoilTorque CreateMagneticCoilTorqueUsingIgrfTxtModel(
string filename,
Point bodyCenterOfMass,
double numberOfLoops,
Scalar current,
Vector directedArea,
Axes bodyAxes
)
Public Shared Function CreateMagneticCoilTorqueUsingIgrfTxtModel (
filename As String,
bodyCenterOfMass As Point,
numberOfLoops As Double,
current As Scalar,
directedArea As Vector,
bodyAxes As Axes
) As MagneticCoilTorque
public:
static MagneticCoilTorque^ CreateMagneticCoilTorqueUsingIgrfTxtModel(
String^ filename,
Point^ bodyCenterOfMass,
double numberOfLoops,
Scalar^ current,
Vector^ directedArea,
Axes^ bodyAxes
)
static member CreateMagneticCoilTorqueUsingIgrfTxtModel :
filename : string *
bodyCenterOfMass : Point *
numberOfLoops : float *
current : Scalar *
directedArea : Vector *
bodyAxes : Axes -> MagneticCoilTorque
Parameters
- filename
- Type: SystemString
String file path for IGRF .txt file. - bodyCenterOfMass
- Type: AGI.Foundation.GeometryPoint
The center of mass of the Earth-orbiting spacecraft. - numberOfLoops
- Type: SystemDouble
The number of current loops in the magnetic torquer coil. - current
- Type: AGI.Foundation.GeometryScalar
The electric current passing through the coil. - directedArea
- Type: AGI.Foundation.GeometryVector
The area of the coil multiplied by the unit vector that is normal
to the plane of the coil such that a positive current traveling through the coil
obeys the right hand rule. - bodyAxes
- Type: AGI.Foundation.GeometryAxes
The body axes of the spacecraft. These should be the
IntegrationAxes
of the PropagationEulerianAxes associated with the spacecraft.
Return Value
Type:
MagneticCoilTorqueA new magnetic coil torque that uses the IGRF model to describe the magnetic field.
Exceptions See Also