your_solver.cpp

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.
 */
#include <cmath>
#include <plask/python.hpp>
using namespace plask;
using namespace plask::python;
 
#include "../your_solver_class_header.hpp"
using namespace plask::category::your_solver;
 
BOOST_PYTHON_MODULE(solver_name)
{
    {CLASS(Class_Name, "YourSolver", "Short solver description.")
        METHOD(python_method_name, method_name, "Short documentation", "name_or_argument_1", arg("name_of_argument_2")=default_value_of_arg_2, ...);
        RO_FIELD(field_name, "Short documentation"); // read-only field
        RW_FIELD(field_name, "Short documentation"); // read-write field
        RO_PROPERTY(python_property_name, get_method_name, "Short documentation"); // read-only property
        RW_PROPERTY(python_property_name, get_method_name, set_method_name, "Short documentation"); // read-write property
        RECEIVER(inReceiver, ""); // receiver in the solver (string is an optional additional documentation)
        PROVIDER(outProvider, ""); // provider in the solver (string is an optional additional documentation)
        BOUNDARY_CONDITIONS(boundary_conditions_name, "Short documentation"); // boundary conditions
    }
 
}