FieldElement.h

Go to the documentation of this file.

/**********************************************************************
** This program is part of 'MOOSE', the
** Messaging Object Oriented Simulation Environment.
**           Copyright (C) 2003-2013 Upinder S. Bhalla. and NCBS
** It is made available under the terms of the
** GNU Lesser General Public License version 2.1
** See the file COPYING.LIB for the full notice.
**********************************************************************/
#ifndef _FIELD_ELEMENT_H
#define _FIELD_ELEMENT_H

class FieldElement: public Element
{
    public:
        FieldElement( Id parent, Id kid, const Cinfo* c, const string& name,
            const FieldElementFinfoBase* fef
        );

        ~FieldElement();

        Element* copyElement( Id newParent, Id newId, unsigned int n,
            bool toGlobal ) const;

        unsigned int numData() const;

        unsigned int numLocalData() const;

        unsigned int localDataStart() const;

        unsigned int numField( unsigned int rawIndex ) const;

        unsigned int totNumLocalField() const;

        unsigned int getNode( unsigned int dataId ) const;

        unsigned int startDataIndex ( unsigned int node ) const;

        unsigned int rawIndex( unsigned int dataId ) const;

        bool hasFields() const {
            return true;
        }

        bool isGlobal() const;

        unsigned int getNumOnNode( unsigned int node ) const;

        // data access stuff

        char* data( unsigned int rawIndex,
                        unsigned int fieldIndex = 0 ) const;

        void resize( unsigned int newNumData );

        void resizeField(
                unsigned int rawIndex, unsigned int newNumField );

        void zombieSwap( const Cinfo* zCinfo );

    private:
        Id parent_;
        const FieldElementFinfoBase* fef_;
};

#endif // _FIELD_ELEMENT_H