/usr/include/trilinos/Teko_JacobiPreconditionerFactory.hpp is in libtrilinos-teko-dev 12.12.1-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 | /*
// @HEADER
//
// ***********************************************************************
//
// Teko: A package for block and physics based preconditioning
// Copyright 2010 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 Eric C. Cyr (eccyr@sandia.gov)
//
// ***********************************************************************
//
// @HEADER
*/
#ifndef __Teko_JacobiPreconditionerFactory_hpp__
#define __Teko_JacobiPreconditionerFactory_hpp__
#include "Teuchos_RCP.hpp"
#include "Teko_BlockPreconditionerFactory.hpp"
#include "Teko_BlockInvDiagonalStrategy.hpp"
namespace Teko {
/** A block diagonal preconditioner.
*
* The use must specify an iverse for each diagonal.
* If a specific integer is not specified, then the default
* "Inverse Type" is used.
\code
<Parameter name="Type" type="string" value="Block Jacobi"/>
<Parameter name="Inverse Type" type="string" value="<Some Inverse Factory>"/>
<Parameter name="Inverse Type 1" type="string" value="<Some Inverse Factory>"/>
<Parameter name="Inverse Type 2" type="string" value="<Some Inverse Factory>"/>
<Parameter name="Inverse Type 3" type="string" value="<Some Inverse Factory>"/>
<Parameter name="Inverse Type 4" type="string" value="<Some Inverse Factory>"/>
<Parameter name="Inverse Type 5" type="string" value="<Some Inverse Factory>"/>
\endcode
*/
class JacobiPreconditionerFactory : public BlockPreconditionerFactory {
public:
//! @name Constructors.
//@{
/** Construct a PreconditionerFactory assuming a specific block
* \f$2\times2\f$ matrix. This case is a simple one.
*/
JacobiPreconditionerFactory(const LinearOp & invD0,const LinearOp & invD1);
/** The most flexible JacobiPreconditionerFactory constructor.
* Pass in a generally defined BlockInvDiagonalStrategy to use the
* full generality of this class.
*/
JacobiPreconditionerFactory(const RCP<const BlockInvDiagonalStrategy> & strategy);
/** Build an empty Jacobi preconditioner factory.
*/
JacobiPreconditionerFactory();
//@}
/** \brief Create the Jacobi preconditioner operator.
*
* This method breaks apart the BlockLinearOp and builds a block
* diagonal preconditioner. The inverse of the diagonals are specified
* by the BlockInvDiagonalStrategy object.
*/
LinearOp buildPreconditionerOperator(BlockedLinearOp & blo,BlockPreconditionerState & state) const;
//! Get inv diagonal strategy
Teuchos::RCP<const BlockInvDiagonalStrategy> getInvDiagStrategy() const
{ return invOpsStrategy_; }
protected:
using Teko::BlockPreconditionerFactory::buildPreconditionerOperator;
//! some members
Teuchos::RCP<const BlockInvDiagonalStrategy> invOpsStrategy_;
//! Initialize from a parameter list
virtual void initializeFromParameterList(const Teuchos::ParameterList & pl);
};
} // end namespace Teko
#endif
|