data/CompositeMatrix.h

Go to the documentation of this file.

/*
 * Copyright 2020 IFPEN-CEA
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#pragma once
 
#include <alien/data/IMatrix.h>
#include <alien/kernels/composite/CompositeMatrixElement.h>
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Alien
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace CompositeKernel
{
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
  class Matrix;
  class MultiMatrixImpl;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
} // namespace CompositeKernel
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ALIEN_EXPORT CompositeMatrix : public IMatrix
{
 public:
  using Element = CompositeKernel::MatrixElement;
 
 public:
  CompositeMatrix();

  CompositeMatrix(Arccore::Integer nc);

  virtual ~CompositeMatrix() {}

  void visit(ICopyOnWriteMatrix& visit) const;

  void resize(Arccore::Integer nc);

  Arccore::Integer size() const;

  const ISpace& rowSpace() const;

  const ISpace& colSpace() const;

  Element composite(Arccore::Integer i, Arccore::Integer j);

  IMatrix& operator()(Arccore::Integer i, Arccore::Integer j);

  const IMatrix& operator()(Arccore::Integer i, Arccore::Integer j) const;

  void setUserFeature(Arccore::String feature);

  bool hasUserFeature(Arccore::String feature) const;
 
 public:
  MultiMatrixImpl* impl();

  const MultiMatrixImpl* impl() const;

  void free();

  void clear();
 
 private:
  std::shared_ptr<CompositeKernel::MultiMatrixImpl> m_impl;
  CompositeKernel::Matrix& m_composite_matrix;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
extern ALIEN_EXPORT CompositeMatrix::Element CompositeElement(
CompositeMatrix& m, Arccore::Integer i, Arccore::Integer j);
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Alien
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/