de.bund.bfr.math.IntegratorFactory.java Source code

Introduction

Here is the source code for de.bund.bfr.math.IntegratorFactory.java

Source

/*******************************************************************************
 * Copyright (c) 2016 German Federal Institute for Risk Assessment (BfR)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Contributors:
 *     Department Biological Safety - BfR
 *******************************************************************************/
package de.bund.bfr.math;

import java.util.Objects;

import org.apache.commons.math3.ode.FirstOrderIntegrator;
import org.apache.commons.math3.ode.nonstiff.ClassicalRungeKuttaIntegrator;
import org.apache.commons.math3.ode.nonstiff.EulerIntegrator;
import org.apache.commons.math3.ode.nonstiff.GillIntegrator;
import org.apache.commons.math3.ode.nonstiff.MidpointIntegrator;
import org.apache.commons.math3.ode.nonstiff.ThreeEighthesIntegrator;

public class IntegratorFactory {

    public static enum Type {
        RUNGE_KUTTA("Classical Runge Kutta"), EULER("Euler"), GILL("Gill"), MIDPOINT("Midpoint"), THREE_EIGHTHES(
                "3/8");

        private String name;

        private Type(String name) {
            this.name = name;
        }

        @Override
        public String toString() {
            return name;
        }
    }

    private Type type;
    private double step;

    public IntegratorFactory(Type type, double step) {
        this.type = type;
        this.step = step;
    }

    public FirstOrderIntegrator createIntegrator() {
        switch (type) {
        case EULER:
            return new EulerIntegrator(step);
        case GILL:
            return new GillIntegrator(step);
        case MIDPOINT:
            return new MidpointIntegrator(step);
        case RUNGE_KUTTA:
            return new ClassicalRungeKuttaIntegrator(step);
        case THREE_EIGHTHES:
            return new ThreeEighthesIntegrator(step);
        default:
            throw new RuntimeException("Unknown type of IntegratorFactory: " + type);
        }
    }

    @Override
    public int hashCode() {
        return Objects.hash(type, step);
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }

        if (obj == null || getClass() != obj.getClass()) {
            return false;
        }

        IntegratorFactory other = (IntegratorFactory) obj;

        return type == other.type && step == other.step;
    }
}