---

sequencer.h

Go to the documentation of this file.

/*
 * Copyright (c) 2001 The AUTHORS 
 *   Romeu Andre' Pieritz, Ph.D.        - romeu_pieritz@hotmail.com
 *   Rafael Mendes, Eng.                – mendes_rafael@yahoo.com
 *   Rodrigo Ferraz de Andrade, Eng.    – rferraz@iname.com 
 * All rights reserved.
 *
 * Permission to use, copy and distribute this software and its
 * documentation for educational and personal use, without fee is hereby granted, 
 * provided that the above copyright notice and the following
 * two paragraphs appear in all copies of this software.
 *
 * IN NO EVENT SHALL THE AUTHORS BE LIABLE TO ANY PARTY FOR
 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
 * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE AUTHORS
 * HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * THE AUTHORS SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HERE UNDER IS
 * ON AN "AS IS" BASIS, AND THE AUTHORS HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 *
 * SINMEC Lab. - CFD Sinflow Project - http://www.sinmec.ufsc.br/cfd
 */


// File Define
#ifndef __CSFL_NUM_SEQUENCER_SEQUENCER_H__
#define __CSFL_NUM_SEQUENCER_SEQUENCER_H__

// Include =====================================================================
#include <csfl/sys/core/action.h>

#include <csfl/sys/container/equation.h>
#include <csfl/sys/math/linearsys9d.h>

#include <csfl/math/solver/solver.h>

#include <csfl/field/value/scalar.h>
#include <csfl/field/value/vector.h>


// Namespace
namespace csfl {

//==============================================================================
//              Class ISequencer
//              Description: Base Class for the sequence objects
//==============================================================================
class ISequencerIO;

class ISequencer : 
        virtual public ISFLObject

{

public:

        ISequencer(
                const IString &_id = IString( "Base Sequencer") ,
                IContainerEquation *_contEquation = NULL,
                ISolver *_solver = NULL,
                double _starttime = 0.0, 
                double _finaltime = 1.0, 
                double _steptime = 0.5 );
        ISequencer( ISequencer *_s );
        ~ISequencer();

        const IString ID() { return id; }

        virtual void Run();
        
        int IteratorGlobal() { return itGlobal; }

        void SetMaximumIteratorGlobal( int _v ) { itGlobalMax = _v; }

    void SetIterMax( int _v );

        double RunTime() { return runtime; }
        
        double StartTime() { return starttime; }

        double FinalTime() { return finaltime; }

        virtual ILinearSystem * LSys(){ return lsys; }

        int IterationToWriteFile() { return iterwrite; }

        void SetIterationToWriteFile( int _v ) { iterwrite = _v; }

        double StepTime() { return steptime; }  

        void SetStepTime( double _v ) { steptime = _v; }

        bool Iteract() { return iteract; }

        void SetIteract( bool _v ) { iteract = _v; }

    virtual void SetSolver( ISolver *_solver );
        
        ISolver * Solver() { return solver; }

        void SetTimeFunction( IFunction *_f );
        
        IFunction * TimeFunction() { return timefunction; }

        IContainerEquation * ContainerEquation(){ return contEquation; }

        IAction         ActionRequestBegin, ActionBegin,
                                ActionRequestEnd, ActionEnd, 
                                ActionIteract, 
                                ActionIteractError, ActionSolutionError,        //only for PVs-Energy
                                ActionRequestIteract, ActionRequestRun;

public:

        virtual void Write( ostream & );

        virtual void Read ( istream & );
        

protected:
    ISolver                             *solver;
        ILinearSystem9D         *lsys;
        IContainerEquation      *contEquation;
        IFunction                       *timefunction;
        
        double  starttime, finaltime, steptime, runtime;
    int     itermax, iterwrite, niterwrite;
        bool    iteract, iteractsteptime, convergence;
        
    IString id;   
        int nx, ny;
        int itGlobal, itGlobalMax; 

        //virtual em todas as derivadas.....
        virtual void Begin() {}
    virtual void Solution( double = 0.0 ) {}
        virtual void End() {}
        
        virtual bool IteractError() { return false; }
        virtual bool SolutionError() { return false; }

        virtual void InitVariables() {}
        virtual void ActualizeVariables() {}

        double VariableError( IFieldScalar *, IFieldScalar * );
    double VariableError( IFieldVector *, IFieldVector * );
        friend class ISequencerIO;

};
} // csfl namespace

#endif // __CSFL_NUM_SEQUENCER_SEQUENCER_H__

 

CFD Project | Documents | Downloads | Contact us | Use Terms
© SINMEC/EMC/UFSC, 2001.	All rights reserved.	Last Update: Jan. 18, 2002	Webmaster