baseclass.hxx

// Copyright (C) 2002-2004 Vivien Mallet
//
// This file is part of Multivac library.
// Multivac library provides front-tracking algorithms.
// 
// Multivac 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 2 of the License, or
// (at your option) any later version.
// 
// Multivac 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 (file "license") for more details.
//
// For more information, please see the Multivac home page:
//     http://spacetown.free.fr/fronts/


#ifndef FILE_UPDATER_BASECLASS_HXX


#include "../errors.cxx"
#include <stdio.h>


namespace Multivac
{


  // CLASS DECLARATIONS //

  template <class T>
  class CFastMarchingNode;


  // CUPDATER //


  template <class T>
  class CUpdater
  {


    /***********************
     * TYPEDEF DECLARATION *
     ***********************/

  public:

    typedef CFastMarchingNode<T> heap_node_value_type;
    typedef CFastMarchingNode<T>& heap_node_reference;
    typedef const CFastMarchingNode<T>& heap_node_const_reference;
    typedef CFastMarchingNode<T>* heap_node_pointer;
    typedef const CFastMarchingNode<T>* heap_node_const_pointer;


    /**************
     * ATTRIBUTES *
     **************/

  protected:

    /**** For all methods ****/

    Matrix<T> Temp;

    int offset;

    bool NeedSpeedUpdateFlag;

    bool NeedInitializationFlag;

    /**** For the full matrix level set method ****/


    /**** For the narrow band level set method ****/

    Vector<List<Vector<int> >, Vect_Full,
           NewAlloc<List<Vector<int> > > > Tube;
    int TubeSemiWidth;

    Matrix<int> Barrier;
    int BarrierWidth;

    Matrix<int> OutSpace;
    int OutSpaceWidth;

    ArrayHeap<CFastMarchingNode<T> > TrialPoints;
    Matrix<int> PointersToNodes;
    T TMax;


    /*****************************
     * CONSTRUCTORS & DESTRUCTOR *
     *****************************/

  public:

    CUpdater()  throw();

    virtual ~CUpdater()  throw();


    /***********
     * METHODS *
     ***********/

  public:
  
    /**** For all methods ****/

    virtual bool IsNarrowBand() const = 0;
    virtual bool IsFastMarching() const = 0;

    virtual void Init(CMesh<T>& Mesh, CLevelSet<T>& Phi) = 0;
    virtual void UpdateLevelSet(T Delta_t, CMesh<T>& Mesh,
                                CSpeedFunction<T>& F,
                                CLevelSet<T>& Phi,
                                T CurrentTime) = 0;

    virtual bool NeedSpeedUpdate() const;
    virtual bool NeedInitialization() const;

    virtual Matrix<T>& GetTemp();

    int GetOffset();

    /**** For full matrix level set methods ****/


    /**** For narrow band level set methods ****/

    Vector<List<Vector<int> >, Vect_Full,
           NewAlloc<List<Vector<int> > > >& GetTube();
    int GetTubeSemiWidth() const;

    Matrix<int>& GetBarrier();
    int GetBarrierWidth() const;
    Matrix<int>& GetOutSpace();
    int GetOutSpaceWidth() const;
    
    /**** For fast marching methods ****/

    virtual bool KeepOnWorking() const;

    ArrayHeap<CFastMarchingNode<T> >& GetTrialPoints();
    Matrix<int>& GetPointersToNodes();
    
    T GetTMax();

  };  // CUpdater.


}  // namespace Multivac.


#define FILE_UPDATER_BASECLASS_HXX
#endif

---