Tpetra_FEMultiVector_decl.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//          Tpetra: Templated Linear Algebra Services Package
//                 Copyright (2008) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ************************************************************************
// @HEADER
 
#ifndef TPETRA_FEMULTIVECTOR_DECL_HPP
#define TPETRA_FEMULTIVECTOR_DECL_HPP
 
 
#include "Tpetra_FEMultiVector_fwd.hpp"
#include "Tpetra_MultiVector_decl.hpp"
 
namespace Tpetra {
 
  template <class Scalar,
            class LocalOrdinal,
            class GlobalOrdinal,
            class Node>
  class FEMultiVector :
    public MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>
  {
  private:
    using base_type = ::Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>;
    friend base_type;
 
    void beginFill ();
 
    void endFill ();
 
  public:
 
 
    using scalar_type = Scalar;
    using local_ordinal_type = LocalOrdinal;
    using global_ordinal_type = GlobalOrdinal;
 
    using device_type = typename base_type::device_type;
 
    using execution_space = typename base_type::execution_space;
 
    using node_type = Node;
 
    using dual_view_type = typename base_type::dual_view_type;
 
    using map_type = typename base_type::map_type;
 
    using impl_scalar_type = typename base_type::impl_scalar_type;
 
    using dot_type = typename base_type::dot_type;
 
    using mag_type = typename base_type::mag_type;
 
 
 
    FEMultiVector () = delete;
 
    FEMultiVector (const Teuchos::RCP<const map_type>& map,
                   const Teuchos::RCP<const Import<local_ordinal_type, global_ordinal_type, node_type>>& importer,
                   const size_t numVecs,
                   const bool zeroOut = true);
 
    FEMultiVector (const FEMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>&) = delete;
 
    FEMultiVector (FEMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>&&) = delete;
 
    FEMultiVector&
    operator= (const FEMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>&) = delete;
 
    FEMultiVector&
    operator= (FEMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>&&) = delete;
 
    virtual ~FEMultiVector () = default;
 
 
 
    void beginAssembly ();
 
    void endAssembly ();
 
    void beginModify ();
    void endModify ();
 
    void globalAssemble ();
 
    void doOwnedPlusSharedToOwned(const CombineMode CM=Tpetra::ADD);
 
    void doOwnedToOwnedPlusShared(const CombineMode CM=Tpetra::ADD);
 
    void switchActiveMultiVector();
 
  protected:
    void replaceMap (const Teuchos::RCP<const map_type>& map);
 
    enum FEWhichActive
    {
      FE_ACTIVE_OWNED_PLUS_SHARED,
      FE_ACTIVE_OWNED
    };
 
    enum class FillState
    {
      open,  // matrix is "open".  Values can freely summed in to and replaced
      modify,  // matrix is open for modification.  *local* values can be replaced
      closed
    };
    Teuchos::RCP<FillState> fillState_;
 
    Teuchos::RCP<base_type> inactiveMultiVector_;
 
    Teuchos::RCP<FEWhichActive> activeMultiVector_;
 
    Teuchos::RCP<const Import<local_ordinal_type, global_ordinal_type, node_type>> importer_;
  };
 
} // namespace Tpetra
 
#endif // TPETRA_FEMULTIVECTOR_DECL_HPP