core/materials/IMeshMaterialVariable.h

// -*- 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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IMeshMaterialVariable.h                                     (C) 2000-2023 */
/*                                                                           */
/* Interface d'un variable sur un matériau du maillage.                      */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_MATERIALS_IMESHMATERIALVARIABLE_H
#define ARCANE_CORE_MATERIALS_IMESHMATERIALVARIABLE_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/ItemTypes.h"
#include "arcane/core/materials/MaterialsCoreGlobal.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
class VariableDependInfo;
}
 
namespace Arcane::Materials
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class IMeshMaterialVariableComputeFunction;
class MeshMaterialVariableSynchronizerList;
class MeshMaterialVariableDependInfo;
class MeshMaterialVariableRef;
class ComponentItemListBuilder;
class IMeshMaterialVariableInternal;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
class ARCANE_CORE_EXPORT IMeshMaterialVariable
{
 public:
 
  virtual ~IMeshMaterialVariable() = default;
 
 public:

  virtual String name() const =0;

  virtual IVariable* globalVariable() const =0;

  virtual void buildFromManager(bool is_continue) =0;

  virtual void syncReferences() =0;

  virtual void addVariableRef(MeshMaterialVariableRef* var_ref) =0;

  virtual void removeVariableRef(MeshMaterialVariableRef* var_ref) =0;

  virtual MeshMaterialVariableRef* firstReference() const =0;

  virtual IVariable* materialVariable(IMeshMaterial* mat) =0;

  virtual void setKeepOnChange(bool v) =0;

  virtual bool keepOnChange() const =0;

  virtual void synchronize() =0;
 
  virtual void synchronize(MeshMaterialVariableSynchronizerList& sync_list) =0;

  virtual void dumpValues(std::ostream& ostr) =0;

  virtual void dumpValues(std::ostream& ostr,AllEnvCellVectorView view) =0;

  virtual void fillPartialValuesWithGlobalValues() =0;

  virtual void fillPartialValuesWithSuperValues(Int32 level) =0;

  virtual void serialize(ISerializer* sbuffer,Int32ConstArrayView ids) =0;

  virtual MatVarSpace space() const =0;
 
 public:



  virtual void update(IMeshMaterial* mat) =0;

  virtual void setUpToDate(IMeshMaterial* mat) =0;

  virtual Int64 modifiedTime(IMeshMaterial* mat) =0;

  virtual void addDepend(IMeshMaterialVariable* var) =0;

  virtual void addDepend(IMeshMaterialVariable* var,const TraceInfo& tinfo) =0;

  virtual void addDepend(IVariable* var) =0;

  virtual void addDepend(IVariable* var,const TraceInfo& tinfo) =0;

  virtual void removeDepend(IMeshMaterialVariable* var) =0;

  virtual void removeDepend(IVariable* var) =0;

  virtual void setComputeFunction(IMeshMaterialVariableComputeFunction* v) =0;

  virtual IMeshMaterialVariableComputeFunction* computeFunction() =0;

  virtual void dependInfos(Array<VariableDependInfo>& infos,
                           Array<MeshMaterialVariableDependInfo>& mat_infos) =0;
 
 public:
 
  virtual IMeshMaterialVariableInternal* _internalApi() =0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
template<typename TrueType>
class MeshMaterialVariableBuildTraits
{
 public:
  static ARCANE_CORE_EXPORT MaterialVariableTypeInfo _buildVarTypeInfo(MatVarSpace space);
  static ARCANE_CORE_EXPORT TrueType* getVariableReference(const MaterialVariableBuildInfo& v,MatVarSpace mvs);
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane::Materials
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif