SimpleFixedWingForwardFlightAerodynamics

java.lang.Object
- agi.foundation.infrastructure.DefinitionalObject
- - agi.foundation.aircraftpropagation.SimpleFixedWingForwardFlightAerodynamics

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable
```
public final class SimpleFixedWingForwardFlightAerodynamics
extends DefinitionalObject
```
Defines an aerodynamic model for fixed wing aircraft under nominal forward flight conditions which accounts for lift and drag forces but assumes that the slip (or side) force is zero, by definition.

Constructor Summary

Constructors
Constructor and Description
`SimpleFixedWingForwardFlightAerodynamics()` Initializes a new instance.
`SimpleFixedWingForwardFlightAerodynamics(SimpleFixedWingForwardFlightAerodynamics existingInstance, CopyContext context)` Initializes a new instance as a copy of an existing instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`checkForSameDefinition(DefinitionalObject other)` Checks to determine if another instance has the same definition as this instance and returns `true` if it does.
`Object`	`clone(CopyContext context)` Clones this object using the specified context.
`protected int`	`computeCurrentDefinitionHashCode()` Computes a hash code based on the current properties of this object.
`static double`	`computeDragCoefficient(double dragCoefficientAtMinimum, double liftCoefficient, double oswaldEfficiencyFactor, double aspectRatio, double dragIndex)` Computes the drag coefficient from the provided parameters.
`static double`	`computeLiftCoefficient(double liftCoefficientAtZeroAngleOfAttack, double liftCoefficientSlope, double angleOfAttack)` Computes the lift coefficient from the provided parameters.
`void`	`enumerateDependencies(DependencyEnumerator enumerator)` Enumerates the dependencies of this object by calling `DependencyEnumerator#enumerate(T)` for each object that this object directly depends upon.
`Scalar`	`getAngleOfAttack()` Gets a `Scalar` which provides the value of the angle of attack.
`ValueDefinition<Double>`	`getAspectRatio()` Gets the aspect ratio of the wing.
`ValueDefinition<Double>`	`getDragCoefficientAtMinimum()` Gets the minimum drag coefficient value.
`ValueDefinition<Double>`	`getDragIndex()` Gets the drag index.
`Scalar`	`getDynamicPressure()` Gets a `Scalar` which provides the value of the dynamic pressure.
`Evaluator<Cartesian>`	`getEvaluator()` Gets an evaluator that computes the aerodynamic force in the wind frame as drag, side, and lift force components.
`Evaluator<Cartesian>`	`getEvaluator(EvaluatorGroup group)` Gets an evaluator that computes the aerodynamic force in the wind frame as drag, side, and lift force components.
`ValueDefinition<Double>`	`getLiftCoefficientAtZeroAngleOfAttack()` Gets the lift coefficient value at zero angle of attack.
`ValueDefinition<Double>`	`getLiftCoefficientSlope()` Gets the lift coefficient slope with respect to the angle of attack in units of radians^-1.
`ValueDefinition<Double>`	`getOswaldEfficiencyFactor()` Gets the Oswald efficiency factor for the wing.
`ValueDefinition<Double>`	`getReferenceArea()` Gets the reference area of the wing.
`void`	`setAngleOfAttack(Scalar value)` Sets a `Scalar` which provides the value of the angle of attack.
`void`	`setAspectRatio(ValueDefinition<Double> value)` Sets the aspect ratio of the wing.
`void`	`setDragCoefficientAtMinimum(ValueDefinition<Double> value)` Sets the minimum drag coefficient value.
`void`	`setDragIndex(ValueDefinition<Double> value)` Sets the drag index.
`void`	`setDynamicPressure(Scalar value)` Sets a `Scalar` which provides the value of the dynamic pressure.
`void`	`setLiftCoefficientAtZeroAngleOfAttack(ValueDefinition<Double> value)` Sets the lift coefficient value at zero angle of attack.
`void`	`setLiftCoefficientSlope(ValueDefinition<Double> value)` Sets the lift coefficient slope with respect to the angle of attack in units of radians^-1.
`void`	`setOswaldEfficiencyFactor(ValueDefinition<Double> value)` Sets the Oswald efficiency factor for the wing.
`void`	`setReferenceArea(ValueDefinition<Double> value)` Sets the reference area of the wing.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SimpleFixedWingForwardFlightAerodynamics
```
public SimpleFixedWingForwardFlightAerodynamics()
```
    Initializes a new instance.
  - SimpleFixedWingForwardFlightAerodynamics
```
public SimpleFixedWingForwardFlightAerodynamics(@Nonnull
                                                SimpleFixedWingForwardFlightAerodynamics existingInstance,
                                                @Nonnull
                                                CopyContext context)
```
    Initializes a new instance as a copy of an existing instance.
    See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.
    
    Parameters:
    
    existingInstance - The existing instance to copy.
    
    context - A CopyContext that controls the depth of the copy.
    
    Throws:
    
    ArgumentNullException - Thrown when existingInstance or context is null.
- Method Detail
  - clone
```
public Object clone(CopyContext context)
```
    Clones this object using the specified context.
    
    This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.
    
    A typical implementation of ICloneWithContext:
```
public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}
```
    In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:
    1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
    2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.
    If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.
```
alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}
```
    If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:
    1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
    2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
    3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.
```
public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;
```
    Specified by:
    
    clone in interface ICloneWithContext
    
    Specified by:
    
    clone in class DefinitionalObject
    
    Parameters:
    
    context - The context to use to perform the copy.
    
    Returns:
    
    A new instance which is a copy of this object.
  - checkForSameDefinition
```
protected boolean checkForSameDefinition(DefinitionalObject other)
```
    Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).
    
    Specified by:
    
    checkForSameDefinition in class DefinitionalObject
    
    Parameters:
    
    other - The other instance to compare to this one.
    
    Returns:
    
    true if the two objects are defined equivalently; otherwise false.
  - computeCurrentDefinitionHashCode
```
protected int computeCurrentDefinitionHashCode()
```
    Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the SimpleFixedWingForwardFlightAerodynamics.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.
    
    Overrides:
    
    computeCurrentDefinitionHashCode in class DefinitionalObject
    
    Returns:
    
    The computed hash code.
  - enumerateDependencies
```
public void enumerateDependencies(DependencyEnumerator enumerator)
```
    Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.
    
    Specified by:
    
    enumerateDependencies in interface IEnumerateDependencies
    
    Overrides:
    
    enumerateDependencies in class DefinitionalObject
    
    Parameters:
    
    enumerator - The enumerator that is informed of the dependencies of this object.
  - computeLiftCoefficient
```
public static double computeLiftCoefficient(double liftCoefficientAtZeroAngleOfAttack,
                                            double liftCoefficientSlope,
                                            double angleOfAttack)
```
    Computes the lift coefficient from the provided parameters.
    
    Parameters:
    
    liftCoefficientAtZeroAngleOfAttack - The lift coefficient value at zero angle of attack.
    
    liftCoefficientSlope - The lift coefficient slope with respect to the angle of attack in units of radians^-1.
    
    angleOfAttack - The angle of attack.
    
    Returns:
    
    The coefficient of lift.
  - computeDragCoefficient
```
public static double computeDragCoefficient(double dragCoefficientAtMinimum,
                                            double liftCoefficient,
                                            double oswaldEfficiencyFactor,
                                            double aspectRatio,
                                            double dragIndex)
```
    Computes the drag coefficient from the provided parameters.
    
    Parameters:
    
    dragCoefficientAtMinimum - The minimum drag coefficient value.
    
    liftCoefficient - The coefficient of lift.
    
    oswaldEfficiencyFactor - The Oswald efficiency factor for the wing.
    
    aspectRatio - The aspect ratio of the wing.
    
    dragIndex - The drag index.
    
    Returns:
    
    The coefficient of drag.
  - getAngleOfAttack
```
public final Scalar getAngleOfAttack()
```
    Gets a Scalar which provides the value of the angle of attack.
  - setAngleOfAttack
```
public final void setAngleOfAttack(Scalar value)
```
    Sets a Scalar which provides the value of the angle of attack.
  - getDynamicPressure
```
public final Scalar getDynamicPressure()
```
    Gets a Scalar which provides the value of the dynamic pressure.
  - setDynamicPressure
```
public final void setDynamicPressure(Scalar value)
```
    Sets a Scalar which provides the value of the dynamic pressure.
  - getAspectRatio
```
public final ValueDefinition<Double> getAspectRatio()
```
    Gets the aspect ratio of the wing.
  - setAspectRatio
```
public final void setAspectRatio(ValueDefinition<Double> value)
```
    Sets the aspect ratio of the wing.
  - getReferenceArea
```
public final ValueDefinition<Double> getReferenceArea()
```
    Gets the reference area of the wing.
  - setReferenceArea
```
public final void setReferenceArea(ValueDefinition<Double> value)
```
    Sets the reference area of the wing.
  - getLiftCoefficientAtZeroAngleOfAttack
```
public final ValueDefinition<Double> getLiftCoefficientAtZeroAngleOfAttack()
```
    Gets the lift coefficient value at zero angle of attack.
  - setLiftCoefficientAtZeroAngleOfAttack
```
public final void setLiftCoefficientAtZeroAngleOfAttack(ValueDefinition<Double> value)
```
    Sets the lift coefficient value at zero angle of attack.
  - getLiftCoefficientSlope
```
public final ValueDefinition<Double> getLiftCoefficientSlope()
```
    Gets the lift coefficient slope with respect to the angle of attack in units of radians^-1.
  - setLiftCoefficientSlope
```
public final void setLiftCoefficientSlope(ValueDefinition<Double> value)
```
    Sets the lift coefficient slope with respect to the angle of attack in units of radians^-1.
  - getDragCoefficientAtMinimum
```
public final ValueDefinition<Double> getDragCoefficientAtMinimum()
```
    Gets the minimum drag coefficient value.
  - setDragCoefficientAtMinimum
```
public final void setDragCoefficientAtMinimum(ValueDefinition<Double> value)
```
    Sets the minimum drag coefficient value.
  - getDragIndex
```
public final ValueDefinition<Double> getDragIndex()
```
    Gets the drag index.
  - setDragIndex
```
public final void setDragIndex(ValueDefinition<Double> value)
```
    Sets the drag index.
  - getOswaldEfficiencyFactor
```
public final ValueDefinition<Double> getOswaldEfficiencyFactor()
```
    Gets the Oswald efficiency factor for the wing.
  - setOswaldEfficiencyFactor
```
public final void setOswaldEfficiencyFactor(ValueDefinition<Double> value)
```
    Sets the Oswald efficiency factor for the wing.
  - getEvaluator
```
@Nonnull
public final Evaluator<Cartesian> getEvaluator()
```
    Gets an evaluator that computes the aerodynamic force in the wind frame as drag, side, and lift force components. The side force is zero, by definition, for this aerodynamic model.
    
    Returns:
    
    The evaluator that computes the aerodynamic force in the wind frame as drag, side, and lift force components.
    
    Throws:
    
    PropertyInvalidException - Thrown when the property AngleOfAttack (get / set) or DynamicPressure (get / set) is null.
  - getEvaluator
```
@Nonnull
public final Evaluator<Cartesian> getEvaluator(@Nonnull
                                                         EvaluatorGroup group)
```
    Gets an evaluator that computes the aerodynamic force in the wind frame as drag, side, and lift force components. The side force is zero, by definition, for this aerodynamic model.
    
    Parameters:
    
    group - The group in which to create the evaluator and its dependents.
    
    Returns:
    
    The evaluator that computes the aerodynamic force in the wind frame as drag, side, and lift force components.
    
    Throws:
    
    ArgumentNullException - Thrown when group is null.
    
    PropertyInvalidException - Thrown when the property AngleOfAttack (get / set) or DynamicPressure (get / set) is null.

Class SimpleFixedWingForwardFlightAerodynamics

Constructor Summary

Method Summary

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

Methods inherited from class java.lang.Object

Constructor Detail

SimpleFixedWingForwardFlightAerodynamics

Method Detail

clone

checkForSameDefinition

computeCurrentDefinitionHashCode

enumerateDependencies

computeLiftCoefficient

computeDragCoefficient

getAngleOfAttack

setAngleOfAttack

getDynamicPressure

setDynamicPressure

getAspectRatio

setAspectRatio

getReferenceArea

setReferenceArea

getLiftCoefficientAtZeroAngleOfAttack

setLiftCoefficientAtZeroAngleOfAttack

getLiftCoefficientSlope

setLiftCoefficientSlope

getDragCoefficientAtMinimum

setDragCoefficientAtMinimum

getDragIndex

setDragIndex

getOswaldEfficiencyFactor

setOswaldEfficiencyFactor

getEvaluator

getEvaluator