FaceElementStencil.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2018-2020 Total, S.A
 * Copyright (c) 2019-     GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */

#ifndef GEOSX_FINITEVOLUME_FACEELEMENTSTENCIL_HPP_
#define GEOSX_FINITEVOLUME_FACEELEMENTSTENCIL_HPP_

#include "StencilBase.hpp"

namespace geosx
{

// TODO remove! This option allows for the creation of new mass inside a newly
// created FaceElement. The new mass will be equal to:
// creationMass = defaultDensity * defaultAperture * faceArea.
// If 0, then the beginning of step density is artificially set to zero...which
// may cause some newton convergence problems.
#define ALLOW_CREATION_MASS 1


// TODO remove! This option sets the pressure in a newly created FaceElement to
// be the lowest value of all attached non-new FaceElements.
#define SET_CREATION_PRESSURE 1

// TODO remove! This option sets the nodal displacements attached a newly
// created FaceElement to some scalar fraction of the aperture of the
// lowest attached non-new FaceElements.
#define SET_CREATION_DISPLACEMENT 0

struct FaceElementStencil_Traits
{
  using IndexContainerType = ArrayOfArrays< localIndex >;

  using IndexContainerViewType = ArrayOfArraysView< localIndex >;

  using IndexContainerViewConstType = ArrayOfArraysView< localIndex const >;

  using WeightContainerType = ArrayOfArrays< real64 >;

  using WeightContainerViewType = ArrayOfArraysView< real64 >;

  using WeightContainerViewConstType = ArrayOfArraysView< real64 const >;

  static localIndex constexpr NUM_POINT_IN_FLUX = 6;

  static localIndex constexpr MAX_STENCIL_SIZE = 6;
};

class FaceElementStencil : public StencilBase< FaceElementStencil_Traits, FaceElementStencil >,
  public FaceElementStencil_Traits
{
public:

  FaceElementStencil();

  virtual void move( LvArray::MemorySpace const space ) override final;

  virtual void add( localIndex const numPts,
                    localIndex const * const elementRegionIndices,
                    localIndex const * const elementSubRegionIndices,
                    localIndex const * const elementIndices,
                    real64 const * const weights,
                    localIndex const connectorIndex ) override final;

  void add( localIndex const numPts,
            R1Tensor const * const cellCenterToEdgeCenter,
            localIndex const connectorIndex );

  virtual localIndex size() const override final
  { return m_elementRegionIndices.size(); }

  localIndex stencilSize( localIndex index ) const
  { return m_elementRegionIndices.sizeOfArray( index ); }

  ArrayOfArraysView< R1Tensor const > getCellCenterToEdgeCenters() const
  { return m_cellCenterToEdgeCenters.toViewConst(); }

private:

  ArrayOfArrays< R1Tensor > m_cellCenterToEdgeCenters;

};

} /* namespace geosx */

#endif /* GEOSX_FINITEVOLUME_FACEELEMENTSTENCIL_HPP_ */