mapProperty with submodules

[daniele-baccega]

Hello,
I'm having an issue with the function mapProperty() that can be used inside a submodule.
It seems that it doesn't map the values correctly. In the properties in the main model, I have some values, but in the submodule I have all 0s (the default values). With macroProperty it works (using mapMacroProperty()).

Do you have any idea about this weird behaviour?

Here you can find a piece of the code in the submodule file:

// Define submodel's environment
void define_environment_submodule(ModelDescription &smm) {
    EnvironmentDescription env = smm.Environment();

    env.newProperty<unsigned short>(RUN_IDX, 0);
    env.newProperty<float, V>(NODE_X, {0.0f});
    env.newProperty<float, V>(NODE_Z, {0.0f});
    env.newProperty<float, V>(NODE_LENGTH, {0.0f});
    env.newProperty<float, V>(NODE_WIDTH, {0.0f});
    env.newProperty<unsigned short, V>(INDEX2COORDX, {0});
    env.newProperty<unsigned short, V>(INDEX2COORDY, {0});
    env.newProperty<unsigned short, V>(INDEX2COORDZ, {0});
    env.newMacroProperty<float, TOTAL_AGENTS_ESTIMATION, SOLUTION_LENGTH>(INTERMEDIATE_TARGET_X);
    env.newMacroProperty<float, TOTAL_AGENTS_ESTIMATION, SOLUTION_LENGTH>(INTERMEDIATE_TARGET_Y);
    env.newMacroProperty<float, TOTAL_AGENTS_ESTIMATION, SOLUTION_LENGTH>(INTERMEDIATE_TARGET_Z);
    env.newMacroProperty<unsigned int, TOTAL_AGENTS_ESTIMATION, SOLUTION_LENGTH>(STAY);
    env.newMacroProperty<short, FLOORS, ENV_DIM_Z, ENV_DIM_X>(COORD2INDEX);
    env.newMacroProperty<short, V, MAX_DIMENSION, MAX_DIMENSION>(ROOM_MATRICES);
    env.newMacroProperty<float, V, 2>(ROOM_DOORS_POSITION);
    env.newMacroProperty<short, V>(ROOMS_HAS_OBJECTS);
    env.newMacroProperty<float, V, MAX_OBJECTS+1>(ROOMS_X_OBJECTS);
    env.newMacroProperty<float, V, MAX_OBJECTS+1>(ROOMS_Z_OBJECTS);
    env.newMacroProperty<float, V, MAX_OBJECTS+1>(ROOMS_LENGTH_OBJECTS);
    env.newMacroProperty<float, V, MAX_OBJECTS+1>(ROOMS_WIDTH_OBJECTS);
    env.newMacroProperty<unsigned int, V, MAX_OBJECTS+1>(ROOMS_RESOURCES_GLOBAL_OBJECTS);
    env.newMacroProperty<unsigned int, V, MAX_OBJECTS+1>(ROOMS_RESOURCES_GLOBAL_OBJECTS_COUNTER);
    env.newMacroProperty<unsigned int, NUMBER_OF_AGENTS_TYPES, V, MAX_OBJECTS+1>(ROOMS_RESOURCES_SPECIFIC_OBJECTS);
    env.newMacroProperty<unsigned int, NUMBER_OF_AGENTS_TYPES, V, MAX_OBJECTS+1>(ROOMS_RESOURCES_SPECIFIC_OBJECTS_COUNTER);
}

// Define submodel's messages
void define_message_submodule(ModelDescription &smm) {
    // Location pedestrian message
    MessageSpatial3D::Description pedestrian_message = smm.newMessage<MessageSpatial3D>("location_submodule");
    pedestrian_message.newVariable<id_t>(ID);
    pedestrian_message.newVariable<short>(CONTACTS_ID);
    pedestrian_message.setRadius(3.0f);
    pedestrian_message.setMin(0, 0, 0);
    pedestrian_message.setMax(ENV_DIM_X, ENV_DIM_Y, ENV_DIM_Z);
}

// Define submodel's agents
void define_agent_submodule(ModelDescription &smm) {
    AgentDescription pedestrian_sm = smm.newAgent("pedestrian_submodule");

    // Variables
    pedestrian_sm.newVariable<float>(X);
    pedestrian_sm.newVariable<float>(Y);
    pedestrian_sm.newVariable<float>(Z);
    pedestrian_sm.newVariable<float>(ANIMATE);
    pedestrian_sm.newVariable<char>(ANIMATE_DIR, 1);
    pedestrian_sm.newVariable<float>(VELX);
    pedestrian_sm.newVariable<float>(VELY);
    pedestrian_sm.newVariable<float>(VELZ);
    pedestrian_sm.newVariable<float>(STEER_X);
    pedestrian_sm.newVariable<float>(STEER_Y);
    pedestrian_sm.newVariable<float>(STEER_Z);
    pedestrian_sm.newVariable<char>(CAN_MOVE);
    pedestrian_sm.newVariable<char>(SKIP_FLOW);
    pedestrian_sm.newVariable<float, 3>(FINAL_TARGET);
    pedestrian_sm.newVariable<short>(CONTACTS_ID, -1);
    pedestrian_sm.newVariable<short>(AGENT_TYPE);
    pedestrian_sm.newVariable<unsigned short>(TARGET_INDEX);
    pedestrian_sm.newVariable<unsigned short>(NEXT_INDEX);
    pedestrian_sm.newVariable<short>(ACTUAL_NODE);
    pedestrian_sm.newVariable<short>(ACTUAL_NODE_STAY);
    pedestrian_sm.newVariable<short>(ACTUAL_NODE_OBJECT);
    pedestrian_sm.newVariable<unsigned char>(MOVEMENT_PHASE);

    AgentFunctionDescription output_location = smm.Agent("pedestrian_submodule").newFunction("outputPedestrianLocationSub", outputPedestrianLocationSub);
    output_location.setMessageOutput("location_submodule");

    AgentFunctionDescription move = smm.Agent("pedestrian_submodule").newFunction("move_agent_function", move_agent_function);
    move.setMessageOutputOptional(true);

    AgentFunctionDescription avoid = smm.Agent("pedestrian_submodule").newFunction("avoid_pedestrians", avoid_pedestrians);
    avoid.setMessageInput("location_submodule");
    avoid.setMessageOutputOptional(true);
}

// Define submodel's layers
void define_layer_submodule(ModelDescription &smm) {
    {
        LayerDescription layer = smm.newLayer();
        layer.addAgentFunction(outputPedestrianLocationSub);
    }
    {
        LayerDescription layer1 = smm.newLayer();
        layer1.addAgentFunction(avoid_pedestrians);
    }
    {
        LayerDescription layer = smm.newLayer();
        layer.addAgentFunction(move_agent_function);
    }
}

// Define submodel
SubModelDescription create_smm(ModelDescription &model) {
    ModelDescription sub_model_move("move_agent_submodule");

    define_environment_submodule(sub_model_move);
    define_message_submodule(sub_model_move);
    define_agent_submodule(sub_model_move);
    define_layer_submodule(sub_model_move);

    SubModelDescription smm = model.newSubModel("move", sub_model_move);
    smm.setMaxSteps(STEP);

    smm.SubEnvironment().mapProperty(RUN_IDX, RUN_IDX);
    smm.SubEnvironment().mapProperty(NODE_X, NODE_X);
    smm.SubEnvironment().mapProperty(NODE_Z, NODE_Z);
    smm.SubEnvironment().mapProperty(NODE_LENGTH, NODE_LENGTH);
    smm.SubEnvironment().mapProperty(NODE_WIDTH, NODE_WIDTH);
    smm.SubEnvironment().mapProperty(INDEX2COORDX, INDEX2COORDX);
    smm.SubEnvironment().mapProperty(INDEX2COORDY, INDEX2COORDY);
    smm.SubEnvironment().mapProperty(INDEX2COORDZ, INDEX2COORDZ);
    smm.SubEnvironment().mapMacroProperty(INTERMEDIATE_TARGET_X, INTERMEDIATE_TARGET_X);
    smm.SubEnvironment().mapMacroProperty(INTERMEDIATE_TARGET_Y, INTERMEDIATE_TARGET_Y);
    smm.SubEnvironment().mapMacroProperty(INTERMEDIATE_TARGET_Z, INTERMEDIATE_TARGET_Z);
    smm.SubEnvironment().mapMacroProperty(STAY, STAY);
    smm.SubEnvironment().mapMacroProperty(COORD2INDEX, COORD2INDEX);
    smm.SubEnvironment().mapMacroProperty(ROOM_MATRICES, ROOM_MATRICES);
    smm.SubEnvironment().mapMacroProperty(ROOM_DOORS_POSITION, ROOM_DOORS_POSITION);
    smm.SubEnvironment().mapMacroProperty(ROOMS_HAS_OBJECTS, ROOMS_HAS_OBJECTS);
    smm.SubEnvironment().mapMacroProperty(ROOMS_X_OBJECTS, ROOMS_X_OBJECTS);
    smm.SubEnvironment().mapMacroProperty(ROOMS_Z_OBJECTS, ROOMS_Z_OBJECTS);
    smm.SubEnvironment().mapMacroProperty(ROOMS_LENGTH_OBJECTS, ROOMS_LENGTH_OBJECTS);
    smm.SubEnvironment().mapMacroProperty(ROOMS_WIDTH_OBJECTS, ROOMS_WIDTH_OBJECTS);
    smm.SubEnvironment().mapMacroProperty(ROOMS_RESOURCES_GLOBAL_OBJECTS, ROOMS_RESOURCES_GLOBAL_OBJECTS);
    smm.SubEnvironment().mapMacroProperty(ROOMS_RESOURCES_GLOBAL_OBJECTS_COUNTER, ROOMS_RESOURCES_GLOBAL_OBJECTS_COUNTER);
    smm.SubEnvironment().mapMacroProperty(ROOMS_RESOURCES_SPECIFIC_OBJECTS, ROOMS_RESOURCES_SPECIFIC_OBJECTS);
    smm.SubEnvironment().mapMacroProperty(ROOMS_RESOURCES_SPECIFIC_OBJECTS_COUNTER, ROOMS_RESOURCES_SPECIFIC_OBJECTS_COUNTER);

    smm.bindAgent("pedestrian_submodule", "pedestrian", true, true);

    return smm;
}
#endif //_MOVEMENT_SUBMODULE_CUH_

Thanks a lot!

[Robadob]

We have test cases which should provide coverage of sub-environment.

https://github.com/FLAMEGPU/FLAMEGPU2/blob/master/tests/test_cases/runtime/environment/test_subenvironment_manager.cu

But I'll give this a play later in the week and see whether I can reproduce with your code.

[daniele-baccega]

I forgot to say that I read the properties from an XML file

[Robadob]

Thanks for the tip, I think I've identified the cause and put together a fix here: #1401

Still need to write a test-case, which will be a little awkward, given it involves an input file. But this should be merged before our next release (which will hopefully be in the next month or so).

[daniele-baccega]

Thank you very much!

[Robadob]

I've now created the test-case, so confirmed it does fix. Presumably PR will be merged on Tuesday during our weekly meeting, but as previously mentioned we are hoping to put out a release soon.