fr.cnes.sirius.patrius.assembly.properties

Class RadiativeCrossSectionProperty

java.lang.Object

fr.cnes.sirius.patrius.assembly.properties.RadiativeCrossSectionProperty

All Implemented Interfaces:

IPartProperty

Direct Known Subclasses:

RadiativeSphereProperty

public class RadiativeCrossSectionProperty
extends Object
implements IPartProperty

This class is a cross section property providing the cross section of shapes such as sphere, cylinder or parallelepiped. This cross section is to be used in radiative models for SRP force computation.

Since:

3.4

Version:

$Id$

Author:

rodriguest

Concurrency :

immutable

Constructor Summary

Constructors

Constructor and Description
RadiativeCrossSectionProperty(CrossSectionProvider shape) Constructor of this property defining the vehicle main shape.

Method Summary

Modifier and Type	Method and Description
double	getCrossSection(SpacecraftState state, Vector3D flux, Frame mainPartFrame, Frame partFrame) Compute the cross section of main shape using the relative velocity in the part (having the aero property) frame as the direction to provider to the CrossSectionProvider.getCrossSection(Vector3D).
PropertyType	getType() Get the type of the property.

Methods inherited from class java.lang.Object

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

Constructor Detail

RadiativeCrossSectionProperty

public RadiativeCrossSectionProperty(CrossSectionProvider shape)

Constructor of this property defining the vehicle main shape.

Parameters:

shape - the main shape

Method Detail

getCrossSection

public double getCrossSection(SpacecraftState state,
                              Vector3D flux,
                              Frame mainPartFrame,
                              Frame partFrame)
                       throws PatriusException

Compute the cross section of main shape using the relative velocity in the part (having the aero property) frame as the direction to provider to the CrossSectionProvider.getCrossSection(Vector3D).

Parameters:

state - the current state of the spacecraft

flux - the incoming flux in the state frame

mainPartFrame - main frame

partFrame - frame of part owning the property

Returns:

the cross section of the main shape.

Throws:

PatriusException - if some frame specific error occurs

getType

public PropertyType getType()

Get the type of the property.

Specified by:

getType in interface IPartProperty

Returns:

the type of the property (see PropertyType enumeration)