---

field.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_CORE_FIELD_H__
#define __CSFL_FIELD_CORE_FIELD_H__


// Include
#include <csfl/sys/core/sflobject.h>
#include <csfl/geom/grid/grid.h>


// Namespace
namespace csfl {

//==============================================================================
//              Class IField
//              Description: Represents a physical discretized field of any     property
//==============================================================================

class IField : 
        virtual public ISFLObject


{

public:
        IField( const IString &_name = IString::empty, IGrid *_grid = NULL );
        IField( const IString &_name, const ISize &_size );
        IField( const IString &_name, int _row, int _col );
        
        IField( IField *_field );

        ~IField();

        inline const IField & operator = ( const IField &_field );
        
        inline virtual double Value( const IPoint &_p = IPoint::zero ) const;
        inline virtual double Value( int _x = 0, int _y = 0 ) const;


        IString ID() { return name; }
        
        void SetID( const IString & _id )
                { name = _id; }
        
    IString Name() { return name; }

        void SetName( const IString & _s ) { name = _s; }

        ISize Size() { return fsize; }

public:
        
        virtual void Read( ifstream & ) {}
        virtual void Read( ifstream &, ifstream & ) {}
 
    virtual void Write( ofstream & ) {}
    virtual void Write( ofstream &, ofstream & ) {}

protected:
        IString name;
        ISize fsize;

};


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

inline const IField & IField::operator = ( const IField &_field )
{
        name = _field.name;
        fsize = _field.fsize;

        return *this;
}

inline double IField::Value( const IPoint &_p ) const
{
        return 1.0;
}

inline double IField::Value( int _x, int _y ) const
{
        return 1.0;
}
} // csfl namespace

#endif// __CSFL_FIELD_CORE_FIELD_H__

 

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