GAS_SynchronizeFields.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:    GAS_SynchronizeFields.h ( GAS Library, C++)
 *
 * COMMENTS:
 */

#ifndef __GAS_SynchronizeFields__
#define __GAS_SynchronizeFields__

#include "GAS_SubSolver.h"
#include "GAS_Utils.h"

/// This DOP simply sets the centers and sizes of the supplied fields (scalar,
/// vector, or matrix) to match the reference field.
class GAS_API GAS_SynchronizeFields : public GAS_SubSolver
{
public:
    GET_DATA_FUNC_S("reference", ReferenceField);
    GET_DATA_FUNC_S("fields", Fields);

protected:
    explicit GAS_SynchronizeFields(const SIM_DataFactory* factory);
            ~GAS_SynchronizeFields() override;

    bool         solveGasSubclass(SIM_Engine& engine,
                                  SIM_Object* obj,
                                  SIM_Time time,
                                  SIM_Time timestep) override;

private:
    static const SIM_DopDescription* getDopDescription();

    DECLARE_STANDARD_GETCASTTOTYPE();
    DECLARE_DATAFACTORY(GAS_SynchronizeFields,
                        GAS_SubSolver,
                        "Gas Synchronize Fields",
                        getDopDescription());
};

#endif