ODESFunc.h

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2002-2025 The Octave Project Developers
//
// See the file COPYRIGHT.md in the top-level directory of this
// distribution or <https://octave.org/copyright/>.
//
// This file is part of Octave.
//
// Octave 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.
//
// Octave 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 Octave; see the file COPYING.  If not, see
// <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////
 
#if ! defined (octave_ODESFunc_h)
#define octave_ODESFunc_h 1
 
#include "octave-config.h"
 
#include "mx-fwd.h"
 
#include "dMatrix.h"
 
class ODESFunc
{
public:
 
  struct DAEJac
  {
    Matrix *dfdxdot;
    Matrix *dfdx;
  };
 
  typedef ColumnVector (*ODES_fsub) (const ColumnVector& x, double,
                                     const ColumnVector& theta);
 
  typedef ColumnVector (*ODES_bsub) (const ColumnVector& x, double,
                                     const ColumnVector& theta, int column);
 
  typedef Matrix (*ODES_jsub) (const ColumnVector& x, double,
                               const ColumnVector& theta);
 
  ODESFunc ()
    : m_fsub (nullptr), m_bsub (nullptr), m_jsub (nullptr) { }
 
  ODESFunc (ODES_fsub f)
    : m_fsub (f), m_bsub (nullptr), m_jsub (nullptr) { }
 
  ODESFunc (ODES_fsub f, ODES_bsub b)
    : m_fsub (f), m_bsub (b), m_jsub (nullptr) { }
 
  ODESFunc (ODES_fsub f, ODES_bsub b, ODES_jsub j)
    : m_fsub (f), m_bsub (b), m_jsub (j) { }
 
  ODESFunc (const ODESFunc& a)
    : m_fsub (a.m_fsub), m_bsub (a.m_bsub), m_jsub (a.m_jsub) { }
 
  ODESFunc& operator = (const ODESFunc& a)
  {
    if (this != &a)
      {
        m_fsub = a.m_fsub;
        m_bsub = a.m_bsub;
        m_jsub = a.m_jsub;
      }
    return *this;
  }
 
  virtual ~ODESFunc () = default;
 
  ODES_fsub fsub_function () const { return m_fsub; }
 
  ODESFunc& set_fsub_function (ODES_fsub f)
  {
    m_fsub = f;
    return *this;
  }
 
  ODES_bsub bsub_function () const { return m_bsub; }
 
  ODESFunc& set_bsub_function (ODES_bsub b)
  {
    m_bsub = b;
    return *this;
  }
 
  ODES_jsub jsub_function () const { return m_jsub; }
 
  ODESFunc& set_jsub_function (ODES_jsub j)
  {
    m_jsub = j;
    return *this;
  }
 
protected:
 
  ODES_fsub m_fsub;
  ODES_bsub m_bsub;
  ODES_jsub m_jsub;
};
 
#endif