---

scalar.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_FIELD_VALUE_SCALAR_H__
#define __CSFL_FIELD_VALUE_SCALAR_H__


// Include
#include <csfl/sys/math/matrix.h>
#include <csfl/field/core/field.h>


// Namespace
namespace csfl {

//==============================================================================
//              Class IFieldScalar
//              Description: Represents a scalar field
//==============================================================================

class IFieldScalar : 
        public IField


{

public:
        IFieldScalar( const IString &_name = IString::empty, 
                IGrid *_grid = NULL, double _value = 0.0 );

        IFieldScalar( const IString &_name, IGrid *_grid, Matrix *_data );

        IFieldScalar( const IString &_name, const ISize &_size, double _value = 0.0 );

        IFieldScalar( const IString &_name, int _row, int _col, double _value = 0.0 );

        IFieldScalar( IFieldScalar *_field );

        ~IFieldScalar();

        inline virtual double Value( const IPoint &_p );

        inline virtual double Value( int _i, int _j );

        double MaxValue();

        double MinValue();
        
        inline const IFieldScalar & operator = ( const IFieldScalar &_field );

        inline void SetValue( const IPoint &_p , double _value );

        inline void SetValue( int _x, int _y, double _value );
        
        void Read( ifstream &_is );

    void Write( ofstream &_os );

protected:
        Matrix *data;

};

// =============================================================================
// Inline functions
// =============================================================================

inline double IFieldScalar::Value( int _i, int _j )
{

    if ( _i>=0.0 && _i<fsize.width && _j>=0.0 && _j<fsize.height)  
        return data->Value( _i, _j );
    else
        return 0.0;
}

inline double IFieldScalar::Value( const IPoint & _p )
{
        return Value( _p.x, _p.y );     
}

inline const IFieldScalar & IFieldScalar::operator = ( const IFieldScalar & _field ) 
{
        ( IFieldScalar & )*this = _field;
        data = _field.data;
        return *this;
}

inline void IFieldScalar::SetValue( const IPoint &_p, double _value )
{

        data->SetValue( _p, _value );
}

inline void IFieldScalar::SetValue( int _x, int _y, double _value )
{
        data->SetValue( _x, _y, _value );
}
     
//==============================================================================
} // csfl namespace

#endif// __CSFL_FIELD_VALUE_SCALAR_H__

 

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