your_solver.hpp

Go to the documentation of this file.

/* 
 * This file is part of PLaSK (https://plask.app) by Photonics Group at TUL
 * Copyright (c) 2022 Lodz University of Technology
 * 
 * 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, version 3.
 *
 * 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.
 */
#ifndef PLASK__SOLVER_YOUR_SOLVER_H
#define PLASK__SOLVER_YOUR_SOLVER_H
 
#include <plask/plask.hpp>
 
namespace plask { namespace ccategory { namespace your_solver {
 
struct YourSolver: public SolverWithMesh<ForExample_Geometry2DCartesian, ForExample_RectilinearMesh2D> {
 
    ReceiverFor<Temperature, Geometry2DCartesian> inTemperature;
 
    ProviderFor<SomeSingleValueProperty>::WithValue outSingleValue;
 
    ProviderFor<SomeFieldProperty, Geometry2DCartesian>::Delegate outSomeField;
 
    YourSolver(const std::string& name="");
 
    virtual std::string getClassName() const { return "NameOfYourSolver"; }
 
    virtual std::string getClassDescription() const {
        return "This solver does this and that. And this description can be e.g. shown as a hint in GUI.";
    }
 
    virtual void loadConfiguration(plask::XMLReader& reader, plask::Manager& manager);
 
    void compute(double parameter);
 
  protected:
 
    DataVector<double> my_data;
 
    virtual void onInitialize();
 
    virtual void onInvalidate();
 
    const DataVector<const double> getDelegated(const MeshD<2>& dst_mesh, InterpolationMethod method=INTERPOLATION_DEFAULT);
 
};
 
 
}}} // namespace
 
#endif