sor.h

Go to the documentation of this file.

/*
 *  Copyright 2008-2014 NVIDIA Corporation
 *
 *  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.
 */

#pragma once

#include <cusp/detail/config.h>
#include <cusp/array1d.h>
#include <cusp/linear_operator.h>

#include <cusp/relaxation/gauss_seidel.h>

namespace cusp
{
namespace relaxation
{

template <typename ValueType, typename MemorySpace>
class sor : public cusp::linear_operator<ValueType, MemorySpace>
{
public:

    /* \cond */
    ValueType default_omega;
    cusp::array1d<ValueType,MemorySpace> temp;
    gauss_seidel<ValueType,MemorySpace> gs;
    /* \endcond */

    sor(void) {}

    template <typename MatrixType>
    sor(const MatrixType& A, const ValueType omega, sweep default_direction=SYMMETRIC)
      : default_omega(omega), temp(A.num_cols), gs(A, default_direction) {}

    template<typename MemorySpace2>
    sor(const sor<ValueType,MemorySpace2>& A)
        : default_omega(A.default_omega), temp(A.temp), gs(A.gs) {}

    template <typename MatrixType, typename VectorType1, typename VectorType2>
    void operator()(const MatrixType& A, const VectorType1& b, VectorType2& x);

    template <typename MatrixType, typename VectorType1, typename VectorType2>
    void operator()(const MatrixType& A, const VectorType1& b, VectorType2& x, const ValueType omega, sweep direction);
};
} // end namespace relaxation
} // end namespace cusp

#include <cusp/relaxation/detail/sor.inl>