AbstractAnalyticalGradientConverter.java

/* Copyright 2002-2025 CS GROUP
 * Licensed to CS GROUP (CS) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * CS licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.orekit.propagation.analytical;

import org.hipparchus.analysis.differentiation.Gradient;
import org.orekit.propagation.integration.AbstractGradientConverter;
import org.orekit.utils.ParameterDriversProvider;

/**
 * Converter for analytical orbit propagator.
 *
 * @author Bryan Cazabonne
 * @since 11.1
 */
public abstract class AbstractAnalyticalGradientConverter
    extends AbstractGradientConverter implements ParameterDriversProvider {

    /**
     * Constructor.
     * @param propagator analytical orbit propagator
     * @param freeStateParameters number of free parameters
     */
    protected AbstractAnalyticalGradientConverter(final AbstractAnalyticalPropagator propagator,
                                                  final int freeStateParameters) {
        super(freeStateParameters);
        initStates(buildBasicGradientSpacecraftState(propagator.getInitialState(), freeStateParameters,
                                                     freeStateParameters > 3 ? propagator.getAttitudeProvider() : null));

    }

    /**
     * Get the converted analytical orbit propagator.
     * @return the converted analytical orbit propagator
     */
    public abstract FieldAbstractAnalyticalPropagator<Gradient> getPropagator();

}