Example of using C# functions for the dataset

Ce répertoire contient un exemple d'utilisation de fonctions C# pour le jeu de données.

CMakeLists.txt File

cmake_minimum_required(VERSION 3.21 FATAL_ERROR)
project(UserFunction LANGUAGES C CXX)
 
find_package(Arcane REQUIRED)
 
add_executable(UserFunction UserFunctionModule.cc main.cc UserFunction_axl.h)
 
arcane_generate_axl(UserFunction)
arcane_add_arcane_libraries_to_target(UserFunction)
target_include_directories(UserFunction PUBLIC . ${CMAKE_CURRENT_BINARY_DIR})
configure_file(UserFunction.config ${CMAKE_CURRENT_BINARY_DIR} COPYONLY)
 
# Command to compile C# file for functions
add_custom_command(OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/ExternalFunctions.dll"
  COMMAND ${ARCANE_PREFIX_DIR}/bin/arcane_dotnet_compile "${CMAKE_CURRENT_LIST_DIR}/ExternalFunctions.cs"
  DEPENDS "${CMAKE_CURRENT_LIST_DIR}/ExternalFunctions.cs"
  WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}")
add_custom_target(external_functions DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/ExternalFunctions.dll")
add_dependencies(UserFunction external_functions)
 
# Add a test to run the sample
add_test(NAME userfunction1 COMMAND ${CMAKE_CURRENT_BINARY_DIR}/UserFunction -A,UsingDotNet=1 ${CMAKE_CURRENT_LIST_DIR}/UserFunction.arc)

ExternalFunctions.cs File

using System;
using Arcane;
using Real = System.Double;
 
namespace UserFunctionSample
{
  public class CaseFunctions
  {
    Real3 m_origin;
 
    // Constructor to initialize instance
    public CaseFunctions()
    {
      m_origin = new Real3(0.2,0.3,0.0);
    }
 
    // User Function.
    public Real3 NodeVelocityFunc(Real global_time,Real3 position)
    {
      Real3 delta = position - m_origin;
      Real dx = delta.x;
      Real dy = delta.y;
      Real dz = delta.z;
      Real norm = 0.3 * System.Math.Sqrt(dx*dx+dy*dy+dz*dz);
      Real vx = global_time * norm * dx;
      Real vy = global_time * norm * dy;
      Real vz = global_time * norm * dz;
      return new Real3(vx,vy,vz);
    }
  }
}

main.cc File

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2023 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
 
#include <arcane/launcher/ArcaneLauncher.h>
 
using namespace Arcane;
 
int
main(int argc,char* argv[])
{
  ArcaneLauncher::init(CommandLineArguments(&argc,&argv));
  auto& app_build_info = ArcaneLauncher::applicationBuildInfo();
  app_build_info.setCodeName("UserFunction");
  app_build_info.setCodeVersion(VersionInfo(1,0,0));
  return ArcaneLauncher::run();
}

UserFunction.arc File

<?xml version="1.0"?>
<case codename="UserFunction" xml:lang="en" codeversion="1.0">
  <arcane>
    <title>Sample</title>
    <timeloop>UserFunctionLoop</timeloop>
  </arcane>
 
  <meshes>
    <mesh>
      <!-- You can use a file instead of a generator using the element
           <filename>/path/to/the/file</filename> instead of <generator/> --> 
      <generator name="Cartesian2D" >
        <nb-part-x>1</nb-part-x> 
        <nb-part-y>1</nb-part-y>
        <origin>0.0 0.0</origin>
        <x><n>20</n><length>2.0</length></x>
        <y><n>20</n><length>2.0</length></y>
      </generator>
    </mesh>
  </meshes>
 
  <functions>
    <external-assembly>
      <assembly-name>ExternalFunctions.dll</assembly-name>
      <class-name>UserFunctionSample.CaseFunctions</class-name>
    </external-assembly>
  </functions>
 
  <arcane-post-processing>
    <output-period>1</output-period>
    <output>
      <variable>NodeVelocity</variable>
    </output>
  </arcane-post-processing>
 
  <user-function>
    <node-velocity function="NodeVelocityFunc">0.0 0.0 0.0</node-velocity>
  </user-function>
 
</case>

UserFunction.axl File

<?xml version="1.0" ?>
<module name="UserFunction" version="1.0">
  <description>Description of the module UserFunction</description>
  <entry-points>
    <entry-point method-name="compute" name="Compute" where="compute-loop" property="none" />
    <entry-point method-name="startInit" name="StartInit" where="start-init" property="none" />
  </entry-points>
  <options>
    <simple name="node-velocity" type="real3" />
  </options>
  <variables>
    <variable name="CellCenter" field-name="cell_center" data-type="real3" dim="0" item-kind="cell" />
    <variable name="NodeVelocity" field-name="node_velocity" data-type="real3" dim="0" item-kind="node" />
  </variables>
</module>

UserFunction.config File

<?xml version="1.0" ?>
 <arcane-config code-name="UserFunction">
  <time-loops>
    <time-loop name="UserFunctionLoop">
      <title>UserFunction</title>
      <description>Default timeloop for code UserFunction</description>
 
      <modules>
        <module name="UserFunction" need="required" />
        <module name="ArcanePostProcessing" need="required" />
      </modules>
 
      <entry-points where="init">
        <entry-point name="UserFunction.StartInit" />
      </entry-points>
      <entry-points where="compute-loop">
        <entry-point name="UserFunction.Compute" />
      </entry-points>
    </time-loop>
  </time-loops>
</arcane-config>

UserFunctionModule.cc File

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2023 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* UserFunctionModule.cc                                       (C) 2000-2023 */
/*                                                                           */
/* Module d'exemple pour les fonctions utilisateur.                          */
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include <arcane/utils/Real3.h>
 
#include <arcane/core/ITimeLoopMng.h>
#include <arcane/core/IMesh.h>
#include <arcane/core/ICaseFunction.h>
#include <arcane/core/IStandardFunction.h>
 
#include "UserFunction_axl.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
using namespace Arcane;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
//! Module UserFunction.
class UserFunctionModule
: public ArcaneUserFunctionObject
{
 public:
 
  explicit UserFunctionModule(const ModuleBuildInfo& mbi)
  : ArcaneUserFunctionObject(mbi)
  {}
 
 public:
 
  //! Method called at each iteration
  void compute() override;
 
  //! Method called at the beginning of the execution
  void startInit() override;
 
  //! Version of the module
  VersionInfo versionInfo() const override { return VersionInfo(1, 0, 0); }
 
 private:
 
  IBinaryMathFunctor<Real, Real3, Real3>* m_node_velocity_functor = nullptr;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void UserFunctionModule::
compute()
{
  info() << "Module UserFunction COMPUTE";
 
  // Stop code after 10 iterations
  if (m_global_iteration() > 10)
    subDomain()->timeLoopMng()->stopComputeLoop(true);
 
  // Loop over the cells and compute the center of each cell
  VariableNodeReal3& nodes_coordinates = defaultMesh()->nodesCoordinates();
  ENUMERATE_ (Cell, icell, allCells()) {
    Cell cell = *icell;
    Real3 cell_center = Real3::zero();
    // Iteration over nodes of the cell
    for (Node node : cell.nodes()) {
      cell_center += nodes_coordinates[node];
    }
    cell_center /= cell.nbNode();
    m_cell_center[icell] = cell_center;
  }
 
  {
    // Compute NodeVelocity using external function
    const Real current_time = m_global_time();
    ENUMERATE_ (Node, inode, allNodes()) {
      Real3 position = nodes_coordinates[inode];
      m_node_velocity[inode] = m_node_velocity_functor->apply(current_time, position);
    }
  }
 
  {
    // Move nodes
    const Real current_deltat = m_global_deltat();
    ENUMERATE_ (Node, inode, allNodes()) {
      nodes_coordinates[inode] += m_node_velocity[inode] * current_deltat;
    }
  }
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void UserFunctionModule::
startInit()
{
  info() << "Module UserFunction INIT";
  m_global_deltat.assign(0.1);
 
  // Check we have user function for node velocity
  {
    ICaseFunction* opt_function = options()->nodeVelocity.function();
    IStandardFunction* scf = options()->nodeVelocity.standardFunction();
    if (!scf)
      ARCANE_FATAL("No standard case function for option 'node-velocity'");
    auto* functor = scf->getFunctorRealReal3ToReal3();
    if (!functor)
      ARCANE_FATAL("Standard function '{0}' is not convertible to f(Real,Real3) -> Real3", opt_function->name());
    m_node_velocity_functor = functor;
  }
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
ARCANE_REGISTER_MODULE_USERFUNCTION(UserFunctionModule);
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/