fr.cnes.sirius.patrius.assembly.models.cook

Class CnCookModel

java.lang.Object

fr.cnes.sirius.patrius.assembly.models.cook.CnCookModel

All Implemented Interfaces:

IParamDiffFunction, IParameterizable, IParameterizableFunction, Serializable

public class CnCookModel
extends Object
implements IParamDiffFunction

This class implements Cook normal coefficient to a facet.

Since:

3.3

Version:

$Id$

Author:

Emmanuel Bignon

See Also:

Serialized Form

Concurrency :

not thread-safe

Constructor Summary

Constructors

Constructor and Description
CnCookModel(ExtendedAtmosphere atmos, Facet afacet, Frame afacetFrame, double eps, double wallGasTemp) Constructor with constant wall gas temperature.
CnCookModel(ExtendedAtmosphere atmos, Facet afacet, Frame afacetFrame, double eps, WallGasTemperatureProvider wallGasTemp) Constructor.

Method Summary

Modifier and Type	Method and Description
double	derivativeValue(Parameter p, SpacecraftState state) Compute the derivative value with respect to the input parameter.
ArrayList<Parameter>	getParameters() Get the supported parameters.
boolean	isDifferentiableBy(Parameter p) Tell if the function is differentiable by the given parameter.
boolean	supportsParameter(Parameter param) Check if a parameter is supported.
double	value(SpacecraftState state) Getting the value of the function.

Methods inherited from class java.lang.Object

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

Constructor Detail

CnCookModel

public CnCookModel(ExtendedAtmosphere atmos,
                   Facet afacet,
                   Frame afacetFrame,
                   double eps,
                   double wallGasTemp)

Constructor with constant wall gas temperature.

Parameters:

atmos - atmosphere

afacet - facet

afacetFrame - facet frame

eps - specular reemission coefficient

wallGasTemp - constant wall gas temperature

CnCookModel

public CnCookModel(ExtendedAtmosphere atmos,
                   Facet afacet,
                   Frame afacetFrame,
                   double eps,
                   WallGasTemperatureProvider wallGasTemp)

Constructor.

Parameters:

atmos - atmosphere

afacet - facet. Facet should be oriented such that facet normal vector is outside the spacecraft. Thus the facet will create drag only if facing the wind

afacetFrame - facet frame

eps - specular reemission coefficient

wallGasTemp - wall gas temperature

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.

derivativeValue

public double derivativeValue(Parameter p,
                              SpacecraftState state)

Compute the derivative value with respect to the input parameter.

Specified by:

derivativeValue in interface IParamDiffFunction

Parameters:

p - parameter

state - current state

Returns:

the derivative value

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

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.