src/IplPaws/PawsFieldData.h

Go to the documentation of this file.

// -*- C++ -*-
// ACL:license
// ----------------------------------------------------------------------
// This software and ancillary information (herein called "SOFTWARE")
// called PAWS (Parallel Application WorkSpace) is made available under
// display this SOFTWARE without charge, provided that this Notice and
// any statement of authorship are reproduced on all copies.  Neither the
// Government nor the University makes any warranty, express or implied,
// or assumes any liability or responsibility for the use of this
// SOFTWARE.
// 
// If SOFTWARE is modified to produce derivative works, such modified
// SOFTWARE should be clearly marked, so as not to confuse it with the
// version available from LANL.
// 
// For more information about PAWS, send e-mail to paws@acl.lanl.gov,
// or visit the PAWS web page at http://www.acl.lanl.gov/paws/.
// ----------------------------------------------------------------------
// ACL:license

#ifndef IpplPawsFieldData_h
#define IpplPawsFieldData_h

#include "IpplPaws/DLDescriptor.h"
#include "Field/Field.h"
#include "Paws/PawsGeneralData.h"

//
// Class which handles the background classes needed to have PAWS
// work on a Ippl Field 
//
template <class T, unsigned Dim,
          class M=UniformCartesian<Dim,double>,
          class C=typename M::DefaultCentering>
class PawsFieldData : public PawsGeneralData< DLRepresentation<NDIndex<Dim>,Dim>,
                                       DLDescriptor<NDIndex<Dim>,Dim,Field<T,Dim,M,C>,T> > 
{
public:

    // Useful typedefs
    typedef Field<T,Dim,M,C>                                    Field_t;
    typedef DLRepresentation<NDIndex<Dim>,Dim>                  Repr;
    typedef DLDescriptor<NDIndex<Dim>,Dim,Field<T,Dim,M,C>,T>   Desc;
    typedef PawsData<Repr,Desc>                                 PawsData_t;

    // Create a completely empty PawsFieldData to be filled by initialize
    PawsFieldData() : PawsGeneralData<Repr,Desc>() {} 

    // Create an unfilled PawsFieldData which will be filled dynamically 
    // when the size is known using update()
    //
    PawsFieldData(const char* name, int io_mode, int sync_mode,
                  int order_mode,
                  PawsApplication& app);

    // Create a PawsFieldData given a sized user Field<T,Dim,M,C> that is
    // distributed by IPPL
    //
    PawsFieldData(const char* name, Field_t*, 
                  int io_mode, int sync_mode, int order_mode,
                  PawsApplication &app);

    // Initialize methods to set up PawsFieldData
    //
    void        initialize(const char* name, int io_mode, int sync_mode,
                        int order_mode, PawsApplication& app);
    void        initialize(const char* name, Field_t* ptr,
                        int io_mode, int sync_mode, int order_mode,
                        PawsApplication& app);

    // Update this PawsFieldData with a new distribution
    // PawsFieldRepresentation is updated
    // update() makes a new schedule
    // resize() does not, since it waits for a return update()
    //
    void        update(Field_t* ptr);
    void        resize(Field_t* ptr);

    int         dataType()              { return PawsTypeCode<T>::myType(); }
    T           sum()                   { if (data_app != PAWS_NULL) 
                                                return data_desc->sum();
                                          else   
                                                return 0;
                                        }
};

template <class T, unsigned Dim, class M, class C>
T sum(PawsFieldData<T,Dim,M,C>& data);


#include "IpplPaws/PawsFieldData.cpp"

#endif

// ACL:rcsinfo
// ----------------------------------------------------------------------
// $RCSfile: PawsFieldData.h,v $   $Author: adelmann $
// $Revision: 1.1.1.1 $   $Date: 2003/01/23 07:40:32 $
// ----------------------------------------------------------------------
// ACL:rcsinfo

/***************************************************************************
 * $RCSfile: addheaderfooter,v $   $Author: adelmann $
 * $Revision: 1.1.1.1 $   $Date: 2003/01/23 07:40:17 $
 * IPPL_VERSION_ID: $Id: addheaderfooter,v 1.1.1.1 2003/01/23 07:40:17 adelmann Exp $ 
 ***************************************************************************/

---