PCDMBackend.h

/*
 * GeohazardVis plug-in: pCDM Modeling
 * Copyright (C) 2017 Karsten Tausche <geodev@posteo.org>
 *
 * 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/>.
 */

#pragma once

#include <array>
#include <vector>

#include <QObject>

#include "pCDM_types.h"


/**
 * pCDM: point Compound Dislocation Model
 * calculates the surface displacements associated with a point CDM that is 
 * composed of three mutually orthogonal point tensile dislocations in a 
 * half-space.
 *
 * Based on Mehdi Nikkhoo's work and MATLAB script:
 * http://volcanodeformation.com/software.html
 *   Created: 2015.5.22
 *   Last modified: 2016.10.18
 *
*/
class PCDMBackend : public QObject
{
    Q_OBJECT

public:
    enum class State
    {
        uninitialized,
        parametersChanged,
        invalidParameters,
        resultsReady,
        errOutOfMemory
    };

    struct Parameters
    {
        pCDM::PointCDMParameters sourceParameters;
        /** Poisson's ratio */
        pCDM::t_FP nu;

        bool operator==(const Parameters & other) const;
        bool operator!=(const Parameters & other) const;
    };

public:
    PCDMBackend();
    ~PCDMBackend() override;

    State state() const;

    void setHorizontalCoords(const std::array<std::vector<pCDM::t_FP>, 2> & coords);
    const std::array<std::vector<pCDM::t_FP>, 2> & horizontalCoords() const;

    void setParameters(const Parameters & parameters);
    const Parameters & parameters() const;

    State run();

    const std::array<std::vector<pCDM::t_FP>, 3> & results() const;
    /** Take the result memory from the backend, omitting an additional copy step. */
    std::array<std::vector<pCDM::t_FP>, 3> && takeResults();

signals:
    void stateChanged(State state);

private:
    State setState(State state);

private:
    State m_state;

    Parameters m_parameters;
    std::array<std::vector<pCDM::t_FP>, 2> m_horizontalCoords;
    std::array<std::vector<pCDM::t_FP>, 3> m_results;
};