VariableRefArray2.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* VariableRefArray2.h                                         (C) 2000-2025 */
/*                                                                           */
/* Class managing a reference to a 2D array variable.                        */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_VARIABLEREFARRAY2_H
#define ARCANE_CORE_VARIABLEREFARRAY2_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/Array2View.h"
#include "arcane/core/VariableRef.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

template <typename T>
class VariableRefArray2T
: public VariableRef
, public Array2View<T>
{
 public:
 
  typedef T DataType;
  typedef Array2<T> ValueType;
  typedef ConstArrayView<T> ConstReturnReferenceType;
  typedef ArrayView<T> ReturnReferenceType;

  typedef DataType ElementType;
  typedef VariableRef BaseClass;
  typedef Array2<DataType> ContainerType;
  typedef Array2View<DataType> ArrayBase;
 
  typedef Array2VariableT<DataType> PrivatePartType;
 
  typedef VariableRefArray2T<DataType> ThatClass;
 
 public:

  ARCANE_CORE_EXPORT VariableRefArray2T(const VariableBuildInfo& vb);
  ARCANE_CORE_EXPORT VariableRefArray2T(const VariableRefArray2T<DataType>& rhs);
  explicit ARCANE_CORE_EXPORT VariableRefArray2T(IVariable* var);
  ARCCORE_DEPRECATED_2021("Use refersTo() instead.")
  ARCANE_CORE_EXPORT void operator=(const VariableRefArray2T<DataType>& rhs);
  virtual ARCANE_CORE_EXPORT ~VariableRefArray2T(); 
 
 public:

  virtual ARCANE_CORE_EXPORT void resize(Integer new_size);

  ARCANE_CORE_EXPORT void resize(Integer dim1_size, Integer dim2_size);

  ARCANE_CORE_EXPORT void fill(const DataType& value);

  ARCANE_CORE_EXPORT void refersTo(const VariableRefArray2T<DataType>& rhs);
 
 public:
 
  virtual bool isArrayVariable() const { return true; }
  virtual Integer arraySize() const { return this->dim1Size(); }
  Integer size() const { return this->dim1Size(); }
  virtual ARCANE_CORE_EXPORT void updateFromInternal();

  ARCCORE_DEPRECATED_2021("Use _internalTrueData() instead.")
  ARCANE_CORE_EXPORT ContainerType& internalContainer();
 
 public:

  ARCANE_CORE_EXPORT IArray2DataInternalT<T>* _internalTrueData();
 
 public:
 
  static ARCANE_CORE_EXPORT VariableTypeInfo _internalVariableTypeInfo();
  static ARCANE_CORE_EXPORT VariableInfo _internalVariableInfo(const VariableBuildInfo& vbi);
 
 private:
 
  PrivatePartType* m_private_part;
 
 private:
 
  static VariableFactoryRegisterer m_auto_registerer;
  static VariableRef* _autoCreate(const VariableBuildInfo& vb);
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif