core/materials/IMeshMaterialMng.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2024 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IMeshMaterialMng.h                                          (C) 2000-2024 */
/*                                                                           */
/* Interface du gestionnaire des matériaux d'un maillage.                    */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_MATERIALS_IMESHMATERIALMNG_H
#define ARCANE_MATERIALS_IMESHMATERIALMNG_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/IFunctorWithArgument.h"
#include "arcane/utils/PlatformUtils.h"
 
#include "arcane/core/materials/MaterialsCoreGlobal.h"
#include "arcane/core/ItemTypes.h"
#include "arcane/core/MeshHandle.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane::Materials
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
class ARCANE_CORE_EXPORT IMeshMaterialMng
{
  friend class MeshMaterialMngFactory;
 
 public:
 
  virtual ~IMeshMaterialMng() = default;
 
 public:
 
  static IMeshMaterialMng* getReference(const MeshHandleOrMesh& mesh_handle,bool create=true);
 
  static Ref<IMeshMaterialMng> getTrueReference(const MeshHandle& mesh_handle,bool create=true);
 
 public:
 
  virtual IMesh* mesh() =0;
 
  virtual ITraceMng* traceMng() =0;
 
 public:
 
  virtual MeshMaterialInfo* registerMaterialInfo(const String& name) =0;
 
  virtual IMeshEnvironment* createEnvironment(const MeshEnvironmentBuildInfo& infos) =0;
 
  virtual IMeshBlock* createBlock(const MeshBlockBuildInfo& infos) =0;
 
  virtual void addEnvironmentToBlock(IMeshBlock* block,IMeshEnvironment* env) =0;
 
  virtual void removeEnvironmentToBlock(IMeshBlock* block,IMeshEnvironment* env) =0;
 
  virtual void endCreate(bool is_continue=false) =0;
 
  virtual void recreateFromDump() =0;
 
  virtual void setKeepValuesAfterChange(bool v) =0;
  
  virtual bool isKeepValuesAfterChange() const =0;
 
  virtual void setDataInitialisationWithZero(bool v) =0;
  
  virtual bool isDataInitialisationWithZero() const =0;
 
  virtual void setMeshModificationNotified(bool v) =0;
 
  virtual bool isMeshModificationNotified() const =0;
 
  virtual void setModificationFlags(int v) =0;
 
  virtual int modificationFlags() const =0;
 
  virtual void setAllocateScalarEnvironmentVariableAsMaterial(bool v) =0;
 
  virtual bool isAllocateScalarEnvironmentVariableAsMaterial() const =0;
 
  virtual String name() const =0;
 
  virtual void setDataCompressorServiceName(const String& name) =0;
 
  virtual String dataCompressorServiceName() const =0;
 
  virtual ConstArrayView<IMeshMaterial*> materials() const =0;
 
  virtual MeshComponentList materialsAsComponents() const =0;
 
  virtual ConstArrayView<IMeshEnvironment*> environments() const =0;
 
  virtual MeshComponentList environmentsAsComponents() const =0;
 
  virtual MeshComponentList components() const =0;
 
  virtual ConstArrayView<IMeshBlock*> blocks() const =0;
 
  virtual IMeshEnvironment* findEnvironment(const String& name,bool throw_exception=true) =0;
 
  virtual IMeshBlock* findBlock(const String& name,bool throw_exception=true) =0;
 
  virtual void fillWithUsedVariables(Array<IMeshMaterialVariable*>& variables) =0;
 
  virtual IMeshMaterialVariable* findVariable(const String& name) =0;
 
  virtual IMeshMaterialVariable* checkVariable(IVariable* global_var) =0;
 
  virtual void dumpInfos(std::ostream& o) =0;
 
  virtual void dumpCellInfos(Cell cell,std::ostream& o) =0;
 
  virtual void checkValid() =0;
 
  virtual AllEnvCellVectorView view(const CellGroup& cells) =0;
 
  virtual AllEnvCellVectorView view(CellVectorView cells) =0;
 
  virtual AllEnvCellVectorView view(SmallSpan<const Int32> cell_local_id) =0;
 
  virtual CellToAllEnvCellConverter cellToAllEnvCellConverter() =0;
 
  virtual void forceRecompute() =0;
 
  virtual Mutex* variableLock() =0;
 
  virtual bool synchronizeMaterialsInCells() =0;
 
  virtual void checkMaterialsInCells(Integer max_print=10) =0;
 
  virtual void visitVariables(IFunctorWithArgumentT<IMeshMaterialVariable*>* functor) =0;
 
  virtual Int64 timestamp() const =0;
 
  virtual void setSynchronizeVariableVersion(Integer version) =0;
 
  virtual Integer synchronizeVariableVersion() const =0;
 
  virtual bool isInMeshMaterialExchange() const =0;
 
  virtual IMeshMaterialVariableFactoryMng* variableFactoryMng() const =0;
 
  virtual void enableCellToAllEnvCellForRunCommand(bool is_enable, bool force_create=false) =0;
  virtual bool isCellToAllEnvCellForRunCommand() const =0;
 
  virtual void setUseMaterialValueWhenRemovingPartialValue(bool v) =0;
  virtual bool isUseMaterialValueWhenRemovingPartialValue() const =0;
 
 public:
 
  class IFactory
  {
   public:
    virtual ~IFactory() = default;
    virtual Ref<IMeshMaterialMng> getTrueReference(const MeshHandle& mesh_handle,bool is_create) =0;
  };
 
 private:
 
  static void _internalSetFactory(IFactory* f);
 
 public:
 
  virtual IMeshMaterialMngInternal* _internalApi() const =0;
 
  virtual IMeshMaterialVariableSynchronizer* _allCellsMatEnvSynchronizer() = 0;
 
  virtual IMeshMaterialVariableSynchronizer* _allCellsEnvOnlySynchronizer() = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane::Materials
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif