src/IplPaws/PawsFieldData.cpp

Go to the documentation of this file.

// -*- C++ -*-
/***************************************************************************
 *
 * The IPPL Framework
 * 
 * This program was prepared by PSI. 
 * All rights in the program are reserved by PSI.
 * Neither PSI nor the author(s)
 * makes any warranty, express or implied, or assumes any liability or
 * responsibility for the use of this software
 *
 * Visit http://www.acl.lanl.gov/POOMS for more details
 *
 ***************************************************************************/

// -*- 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

#include "IpplPaws/PawsFieldData.h"

//
// Construct an empty PawsFieldData which will be filled dynamically
// when the size is determined
//
template <class T, unsigned Dim, class M, class C>
PawsFieldData<T,Dim,M,C>::PawsFieldData(const char* name, int io_mode,
                        int sync_mode, int order_mode, PawsApplication& app)
                        : PawsGeneralData<Repr,Desc>() 
{
    initialize(name, io_mode, sync_mode, order_mode, app);
}


//
// Construct a PawsFieldData given an existing Field_t* distributed by Ippl
// Creates the necessary representation, descriptor, and PawsData
//
template <class T, unsigned Dim, class M, class C>
PawsFieldData<T,Dim,M,C>::PawsFieldData(const char* name, Field_t* ptr,
                                int io_mode, int sync_mode, int order_mode,
                                PawsApplication& app)
                                : PawsGeneralData<Repr,Desc>() 
{
    initialize(name, ptr, 
                io_mode, sync_mode, order_mode, app);
}


//
// Initialization a dynamic PawsFIeldData, data structures are created
// but are not filled with useable information
//
template <class T, unsigned Dim, class M, class C>
void
PawsFieldData<T,Dim,M,C>::initialize(const char* name, int io_mode,
                int sync_mode, int order_mode, PawsApplication& app)
{
    static char* id = "PawsFieldData::initialize(DYNAMIC)";
    PDebug(PAWSD_ARR, ("%s entering\n", id));

    // Check for valid arguments and that we're not already initialized
    //
    PAssert(data_app == PAWS_NULL);
    int valid = true;
    if ((io_mode != PAWS_IN) && (io_mode != PAWS_OUT) &&
        (io_mode != PAWS_INOUT)) {
        PDebug(PAWSD_ERR, ("ERROR: I/O mode flag is not valid\n"));
        valid = false;
    }
    if ((sync_mode != PAWS_SYNC) && (sync_mode != PAWS_ASYNC) &&
        (sync_mode != PAWS_PSYNC)) {
        PDebug(PAWSD_ERR, ("ERROR: Synchronization mode flag is not valid\n"));
        valid = false;
    }
    if ((order_mode != PAWS_ROW) && (order_mode != PAWS_COLUMN)) {
        PDebug(PAWSD_ERR, ("ERROR: Order mode flag is not valid\n"));
        valid = false;
    }
    if (valid == false) {
        PInsist(false, "ERROR: Bad arguments for constructing PawsArray");
    }

    // Set values in the base class PawsDomainData
    data_name = name;
    data_app = &app;

    // Construct the representation, descriptor and PawsData
    //
    data_rep = new Repr(); 
    data_desc = new Desc(*data_rep); 
    paws_data = new PawsData_t(*data_rep, *data_desc, name, io_mode, sync_mode,
                      PAWS_PARALLEL, dataType(), "ARRAY( Field<T,Dim,M,C> )",
                      "IPPL", app);

    // Indicate that this representation has not been initialized with size
    paws_data->updateFlag(PAWS_OFF);

    // Add this object to the list maintained by the PawsApplication
    app.addDomainData(this);
}


//
// Initialization a sized PawsFieldData, data structures are created
// and filled with sized representations and pointers to data
//
template <class T, unsigned Dim, class M, class C>
void
PawsFieldData<T,Dim,M,C>::initialize(const char* name, Field_t* ptr, 
                        int io_mode, int sync_mode, int order_mode,
                        PawsApplication& app)
{
    static char* id = "PawsFieldData::initialize(SIZE)";
    PDebug(PAWSD_ARR, ("%s entering\n", id));

    // Check for valid arguments and that we aren't already initialized
    //
    PAssert(data_app == PAWS_NULL);
    int valid = true;
    if ((io_mode != PAWS_IN) && (io_mode != PAWS_OUT) &&
        (io_mode != PAWS_INOUT)) {
        PDebug(PAWSD_ERR, ("ERROR: I/O mode flag is not valid\n"));
        valid = false;
    }
    if ((sync_mode != PAWS_SYNC) && (sync_mode != PAWS_ASYNC) &&
        (sync_mode != PAWS_PSYNC)) {
        PDebug(PAWSD_ERR, ("ERROR: Synchronization mode flag is not valid\n"));
        valid = false;
    }
    if ((order_mode != PAWS_ROW) && (order_mode != PAWS_COLUMN)) {
        PDebug(PAWSD_ERR, ("ERROR: Order mode flag is not valid\n"));
        valid = false;
    }
    if (valid == false) {
        PInsist(false, "ERROR: Bad arguments for constructing PawsArray");
    }

    // Set values in the base class PawsDomainData
    data_name = name;
    data_app = &app;

    // Construct the representation, descriptor and PawsData
    //
    data_rep = new Repr(ptr->getLayout());
    data_desc = new Desc(*data_rep, ptr);
    PString size_str, desc;
    data_rep->sizeString(size_str);
    desc = "ARRAY(size=" + size_str + ")";
    paws_data = new PawsData_t
                       (*data_rep, *data_desc, name, io_mode, sync_mode,
                       PAWS_PARALLEL, dataType(), desc.c_str(), "PAWS", app);

    // Indicate that this Representation has been sized
    paws_data->updateFlag(PAWS_ON);

    // Add this object to the list maintained by the PawsApplication
    app.addDomainData(this);

    PDebug(PAWSD_ARR, ("%s exiting\n", id));
}


// Calculates a new schedule
// Reports new local representation to master for sending to other applications
//
template <class T, unsigned Dim, class M, class C>
void
PawsFieldData<T,Dim,M,C>::update(Field_t* ptr)
{
    static char* id = "PawsFieldData::update(USERDIST)";
    PAssert(data_app != PAWS_NULL);

    // Build a new layout
    // Update the DLRepresentation, DLDescriptor, PawsData
    // build new schedules, and send message to remotes
    //
    data_rep->update(ptr->getLayout());
    data_desc->update(*data_rep, ptr);
    paws_data->updateFlag(PAWS_ON);

    // Build a local schedule for the updated data
    paws_data->updateLocalData();

    // Send message to remote data master with new representation
    data_app->updateData(paws_data);
    PDebug(PAWSD_ARR, ("%s exiting\n", id));
}


//
// Updates the current representation and descriptor with a new layout
// DOES NOT calculate a new schedule, because it expects a returning update
// Reports new local representation to master for sending to other applications
//
template <class T, unsigned Dim, class M, class C>
void
PawsFieldData<T,Dim,M,C>::resize(Field_t* ptr)
{
    static char* id = "PawsFieldData::resize(USERDIST)";
    PAssert(data_app != PAWS_NULL);

    // Build a new layout
    // Update the DLRepresentation, DLDescriptor, PawsData
    // build new schedules, and send message to remotes
    //
    data_rep->update(ptr->getLayout());
    data_desc->update(*data_rep, ptr);
    paws_data->updateFlag(PAWS_ON);

    // Current schedule is no longer valid
    paws_data->scheduleDoneOff();

    // Send message to remote data master with new representation
    data_app->updateData(paws_data);
    PDebug(PAWSD_ARR, ("%s exiting\n", id));
}


//
// Sum a PawsArray
//
template <class T, unsigned Dim, class M, class C>
T
sum(const PawsFieldData<T,Dim,M,C>& data)
{
    return data.sum();
}


// ACL:rcsinfo
// ----------------------------------------------------------------------
// $RCSfile: PawsFieldData.cpp,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 $ 
 ***************************************************************************/

---