fr.cnes.sirius.patrius.assembly.properties

Class RadiativeSphereProperty

java.lang.Object

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

fr.cnes.sirius.patrius.assembly.properties.RadiativeSphereProperty

All Implemented Interfaces:

IPartProperty

public final class RadiativeSphereProperty
extends RadiativeCrossSectionProperty

This class is a part property for the PATRIUS assembly. It allows the radiative model to use the part with this property.

Since:

1.1

Version:

$Id$

Author:

Gerald Mercadier

Concurrency :

immutable

Constructor Summary

Constructors

Constructor and Description
RadiativeSphereProperty(double inSphereRadius) Constructor with radius.
RadiativeSphereProperty(Parameter inSphereArea) Constructor with area.

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).
double	getSphereArea() Get the sphere area.
double	getSphereRadius() Get the sphere radius.
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

RadiativeSphereProperty

public RadiativeSphereProperty(double inSphereRadius)

Constructor with radius.

Parameters:

inSphereRadius - the sphere radius (m)

RadiativeSphereProperty

public RadiativeSphereProperty(Parameter inSphereArea)

Constructor with area.

Parameters:

inSphereArea - the sphere area (m²)

Method Detail

getSphereRadius

public double getSphereRadius()
                       throws PatriusException

Get the sphere radius.

Returns:

the sphere radius (m)

Throws:

PatriusException - thrown if radius is undefined (negative area)

getSphereArea

public double getSphereArea()

Get the sphere area.

Returns:

the sphere area (m²)

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).

Overrides:

getCrossSection in class RadiativeCrossSectionProperty

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

Overrides:

getType in class RadiativeCrossSectionProperty

Returns:

the type of the property (see PropertyType enumeration)