DTK_NodeToNodeOperator_impl.hpp

Go to the documentation of this file.

//---------------------------------------------------------------------------//
/*
  Copyright (c) 2012, Stuart R. Slattery
  All rights reserved.

  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are
  met:

  *: Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.

  *: 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.

  *: Neither the name of the University of Wisconsin - Madison nor the
  names of its contributors may be used to endorse or promote products
  derived from this software without specific prior written permission.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  "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 THE COPYRIGHT
  HOLDER OR 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.
*/
//---------------------------------------------------------------------------//
//---------------------------------------------------------------------------//

#ifndef DTK_NODETONODE_IMPL_HPP
#define DTK_NODETONODE_IMPL_HPP

#include "DTK_BasicEntityPredicates.hpp"
#include "DTK_CenterDistributor.hpp"
#include "DTK_DBC.hpp"
#include "DTK_EuclideanDistance.hpp"
#include "DTK_NodeToNodeOperator.hpp"
#include "DTK_PredicateComposition.hpp"
#include "DTK_SplineInterpolationPairing.hpp"

#include <Teuchos_ArrayRCP.hpp>
#include <Teuchos_CommHelpers.hpp>
#include <Teuchos_ParameterList.hpp>
#include <Teuchos_Ptr.hpp>

#include <Tpetra_MultiVector.hpp>

namespace DataTransferKit
{
//---------------------------------------------------------------------------//
// Constructor.
template <int DIM>
NodeToNodeOperator<DIM>::NodeToNodeOperator(
    const Teuchos::RCP<const TpetraMap> &domain_map,
    const Teuchos::RCP<const TpetraMap> &range_map,
    const Teuchos::ParameterList &parameters )
    : Base( domain_map, range_map )
{ /* ... */
}

//---------------------------------------------------------------------------//
// Setup the map operator.
template <int DIM>
void NodeToNodeOperator<DIM>::setupImpl(
    const Teuchos::RCP<FunctionSpace> &domain_space,
    const Teuchos::RCP<FunctionSpace> &range_space )
{
    DTK_REQUIRE( Teuchos::nonnull( domain_space ) );
    DTK_REQUIRE( Teuchos::nonnull( range_space ) );

    // Extract the Support maps.
    const Teuchos::RCP<const typename Base::TpetraMap> domain_map =
        this->getDomainMap();
    const Teuchos::RCP<const typename Base::TpetraMap> range_map =
        this->getRangeMap();

    // Get the parallel communicator.
    Teuchos::RCP<const Teuchos::Comm<int>> comm = domain_map->getComm();

    // Determine if we have range and domain data on this process.
    bool nonnull_domain = Teuchos::nonnull( domain_space->entitySet() );
    bool nonnull_range = Teuchos::nonnull( range_space->entitySet() );

    // Extract the source nodes and their ids.
    Teuchos::ArrayRCP<double> source_centers;
    Teuchos::ArrayRCP<GO> source_support_ids;
    getNodeCoordsAndIds( domain_space, source_centers, source_support_ids );

    // Extract the target nodes and their ids.
    Teuchos::ArrayRCP<double> target_centers;
    Teuchos::ArrayRCP<GO> target_support_ids;
    getNodeCoordsAndIds( range_space, target_centers, target_support_ids );

    // Gather the source centers that are in the proximity of the target
    // centers on this proc.
    Teuchos::Array<double> dist_sources;
    CenterDistributor<DIM> distributor(
        comm, source_centers(), target_centers(), 1.0e-3, dist_sources );

    // Gather the global ids of the source centers that are within the proximity
    // of
    // the target centers on this proc.
    Teuchos::Array<GO> dist_source_support_ids( distributor.getNumImports() );
    Teuchos::ArrayView<const GO> source_support_ids_view = source_support_ids();
    distributor.distribute( source_support_ids_view,
                            dist_source_support_ids() );

    // Build the source/target pairings by finding the nearest neighbor - this
    // should be the exact same node.
    SplineInterpolationPairing<DIM> pairings( dist_sources, target_centers(),
                                              true, 1, 0.0 );

    // Build the coupling matrix.
    d_coupling_matrix =
        Teuchos::rcp( new Tpetra::CrsMatrix<Scalar, LO, GO>( range_map, 1 ) );
    Teuchos::Array<GO> indices( 1 );
    Teuchos::Array<double> values( 1, 1.0 );
    int nn = 0;
    int local_num_tgt = target_support_ids.size();
    for ( int i = 0; i < local_num_tgt; ++i )
    {
        // If there is no support for this target center then do not build a
        // local basis.
        if ( 0 < pairings.childCenterIds( i ).size() )
        {
            // If we have a neighbor then there should be only 1.
            DTK_CHECK( 1 == pairings.childCenterIds( i ).size() );

            // Check that our neighbor node has the same coordinates.
            DTK_CHECK(
                std::abs( EuclideanDistance<DIM>::distance(
                    dist_sources( DIM * pairings.childCenterIds( i )[0], DIM )
                        .getRawPtr(),
                    target_centers( DIM * i, DIM ).getRawPtr() ) ) < 1.0e-14 );

            // Get the id of the domain node
            indices[0] =
                dist_source_support_ids[pairings.childCenterIds( i )[0]];

            // Populate the coupling matrix row.
            d_coupling_matrix->insertGlobalValues( target_support_ids[i],
                                                   indices(), values() );
        }
    }
    d_coupling_matrix->fillComplete( domain_map, range_map );
    DTK_ENSURE( d_coupling_matrix->isFillComplete() );
}

//---------------------------------------------------------------------------//
// Apply the operator.
template <int DIM>
void NodeToNodeOperator<DIM>::applyImpl( const TpetraMultiVector &X,
                                         TpetraMultiVector &Y,
                                         Teuchos::ETransp mode, double alpha,
                                         double beta ) const
{
    d_coupling_matrix->apply( X, Y, mode, alpha, beta );
}

//---------------------------------------------------------------------------//
// Transpose apply option.
template <int DIM>
bool NodeToNodeOperator<DIM>::hasTransposeApplyImpl() const
{
    return true;
}

//---------------------------------------------------------------------------//
// Extract node coordinates and ids from an iterator.
template <int DIM>
void NodeToNodeOperator<DIM>::getNodeCoordsAndIds(
    const Teuchos::RCP<FunctionSpace> &space,
    Teuchos::ArrayRCP<double> &centers,
    Teuchos::ArrayRCP<GO> &support_ids ) const
{
    // Get an iterator over the local nodes.
    EntityIterator iterator;
    if ( Teuchos::nonnull( space->entitySet() ) )
    {
        LocalEntityPredicate local_predicate(
            space->entitySet()->communicator()->getRank() );
        PredicateFunction predicate = PredicateComposition::And(
            space->selectFunction(), local_predicate.getFunction() );
        iterator = space->entitySet()->entityIterator( 0, predicate );
    }

    // Extract the coordinates and support ids of the nodes.
    int local_num_node = iterator.size();
    centers = Teuchos::ArrayRCP<double>( DIM * local_num_node );
    support_ids = Teuchos::ArrayRCP<GO>( local_num_node );
    Teuchos::Array<SupportId> node_supports;
    EntityIterator begin = iterator.begin();
    EntityIterator end = iterator.end();
    int entity_counter = 0;
    for ( EntityIterator entity = begin; entity != end;
          ++entity, ++entity_counter )
    {
        space->shapeFunction()->entitySupportIds( *entity, node_supports );
        DTK_CHECK( 1 == node_supports.size() );
        support_ids[entity_counter] = node_supports[0];
        space->localMap()->centroid( *entity,
                                     centers( DIM * entity_counter, DIM ) );
    }
}

//---------------------------------------------------------------------------//

} // end namespace DataTransferKit

//---------------------------------------------------------------------------//

#endif // end DTK_NODETONODE_IMPL_HPP

//---------------------------------------------------------------------------//
// end DTK_NodeToNodeOperator_impl.hpp
//---------------------------------------------------------------------------//