fr.cnes.sirius.patrius.assembly.models.aerocoeffs

Class AbstractAeroCoeff1D

java.lang.Object

fr.cnes.sirius.patrius.assembly.models.aerocoeffs.AbstractAeroCoeff1D

All Implemented Interfaces:

AerodynamicCoefficient, IParamDiffFunction, IParameterizable, IParameterizableFunction, Serializable

Direct Known Subclasses:

AeroCoeffByAltitude, AeroCoeffByAoA, AeroCoeffByMach

public abstract class AbstractAeroCoeff1D
extends Object
implements AerodynamicCoefficient

Aerodynamic coefficient function of one variable. Aerodynamic coefficient is then retrieved by linear interpolation of an array.

Since:

4.1

Version:

$Id$

Author:

Marie Capot

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAeroCoeff1D(double[] xVariables, double[] yVariables) Constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract double	computeXVariable(SpacecraftState state) Computes the x variable from the spacecraft state.
double	derivativeValue(Parameter p, SpacecraftState s) Compute the derivative value with respect to the input parameter.
UniLinearIntervalsFunction	getFunction() Getter for the function.
ArrayList<Parameter>	getParameters() Get the supported parameters.
double[]	getXArray() Getter for the x variable array of values used for the function definition.
double[]	getYArray() Getter for the y variable array of values used for the function definition.
boolean	isDifferentiableBy(Parameter p) Tell if the function is differentiable by the given parameter.
boolean	supportsParameter(Parameter param) Check if a parameter is supported.
String	toString()
double	value(SpacecraftState state) Getting the value of the function.

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.cnes.sirius.patrius.assembly.models.aerocoeffs.AerodynamicCoefficient

getType

Constructor Detail

AbstractAeroCoeff1D

protected AbstractAeroCoeff1D(double[] xVariables,
                              double[] yVariables)

Constructor.

Parameters:

xVariables - array of x variables

yVariables - array of y variables

Method Detail

value

public double value(SpacecraftState state)

Getting the value of the function.

Specified by:

value in interface IParameterizableFunction

Parameters:

state - the spacecraft state

Returns:

the value of the function.

computeXVariable

protected abstract double computeXVariable(SpacecraftState state)
                                    throws PatriusException

Computes the x variable from the spacecraft state.

Parameters:

state - the spacecraft state

Returns:

the x variable

Throws:

PatriusException - if there is a problem computing x from state.

getParameters

public ArrayList<Parameter> getParameters()

Get the supported parameters.

Specified by:

getParameters in interface IParameterizable

Returns:

list of supported parameters

supportsParameter

public boolean supportsParameter(Parameter param)

Check if a parameter is supported.

Specified by:

supportsParameter in interface IParameterizable

Parameters:

param - parameter to check

Returns:

true if the parameter is supported

derivativeValue

public double derivativeValue(Parameter p,
                              SpacecraftState s)

Compute the derivative value with respect to the input parameter.

Specified by:

derivativeValue in interface IParamDiffFunction

Parameters:

p - parameter

s - current state

Returns:

the derivative value

isDifferentiableBy

public boolean isDifferentiableBy(Parameter p)

Tell if the function is differentiable by the given parameter.

Specified by:

isDifferentiableBy in interface IParamDiffFunction

Parameters:

p - function parameter

Returns:

true if the function is differentiable by the given parameter.

getXArray

public double[] getXArray()

Getter for the x variable array of values used for the function definition.

Returns:

the x variable array of values

getYArray

public double[] getYArray()

Getter for the y variable array of values used for the function definition.

Returns:

the y variable array of values

getFunction

public UniLinearIntervalsFunction getFunction()

Getter for the function.

Returns:

the function

toString

public String toString()

Overrides:

toString in class Object