data/CompositeVector.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/IVector.h>
#include <alien/kernels/composite/CompositeVectorElement.h>
#include <alien/utils/ObjectWithTrace.h>
#include <cstdlib>
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Alien
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace CompositeKernel
{
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
  class Vector;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
} // namespace CompositeKernel
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ALIEN_EXPORT CompositeVector : public IVector
, private ObjectWithTrace
{
 public:
  using Element = CompositeKernel::VectorElement;
 
 public:
  CompositeVector();

  CompositeVector(Arccore::Integer nc);

  virtual ~CompositeVector() {}

  void visit(ICopyOnWriteVector&) const;

  const ISpace& space() const;

  void resize(Arccore::Integer nc);

  Arccore::Integer size() const;

  Element composite(Arccore::Integer i);

  IVector& operator[](Arccore::Integer i);

  const IVector& operator[](Arccore::Integer i) const;

  void setUserFeature(Arccore::String feature);

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

  const MultiVectorImpl* impl() const;

  void free();

  void clear();
 
 private:
  std::shared_ptr<MultiVectorImpl> m_impl;
  CompositeKernel::Vector& m_composite_vector;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
extern ALIEN_EXPORT CompositeVector::Element CompositeElement(
CompositeVector& v, Arccore::Integer i);
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Alien
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/