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

java.lang.Object
  extended by fr.cnes.sirius.patrius.assembly.models.cook.CtCookModel
All Implemented Interfaces:
Serializable, IParamDiffFunction, IParameterizable, IParameterizableFunction

public class CtCookModel
extends Object
implements IParamDiffFunction

This class implements Cook tangential coefficient to a facet.

Since:
3.3
Version:
$Id: CtCookModel.java 16763 2016-10-10 09:31:17Z bignon $
Author:
Emmanuel Bignon
See Also:
Serialized Form
Concurrency :
not thread-safe

Constructor Summary
CtCookModel(ExtendedAtmosphere atmos, Facet afacet, Frame afacetFrame, double eps)
          Constructor.
 
Method Summary
 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

CtCookModel

public CtCookModel(ExtendedAtmosphere atmos,
                   Facet afacet,
                   Frame afacetFrame,
                   double eps)
Constructor.

Parameters:
atmos - atmosphere
afacet - facet
afacetFrame - facet frame
eps - specular reemission coefficient
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

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

getParameters

public ArrayList<Parameter> getParameters()
Get the supported parameters.

Specified by:
getParameters in interface IParameterizable
Returns:
list of supported parameters

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.


Copyright © 2016 CNES. All Rights Reserved.