/usr/include/dolfin/fem/NonlinearVariationalProblem.h is in libdolfin1.3-dev 1.3.0+dfsg-2.
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 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 | // Copyright (C) 2011 Anders Logg
//
// This file is part of DOLFIN.
//
// DOLFIN is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// DOLFIN is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with DOLFIN. If not, see <http://www.gnu.org/licenses/>.
//
// Modified by Corrado Maurini, 2013.
//
// First added: 2011-06-22
// Last changed: 2013-03-20
#ifndef __NONLINEAR_VARIATIONAL_PROBLEM_H
#define __NONLINEAR_VARIATIONAL_PROBLEM_H
#include <boost/shared_ptr.hpp>
#include <dolfin/common/Hierarchical.h>
namespace dolfin
{
// Forward declarations
class Form;
class Function;
class FunctionSpace;
class DirichletBC;
class GenericVector;
/// This class represents a nonlinear variational problem:
///
/// Find u in V such that
///
/// F(u; v) = 0 for all v in V^,
///
/// where V is the trial space and V^ is the test space.
class NonlinearVariationalProblem : public Hierarchical<NonlinearVariationalProblem>
{
public:
/// Create nonlinear variational problem without boundary conditions.
/// The Jacobian form is not specified which requires the use of a
/// nonlinear solver that does not rely on the Jacobian.
NonlinearVariationalProblem(const Form& F,
Function& u);
/// Create nonlinear variational problem without boundary conditions.
/// The Jacobian form is specified which allows the use of a nonlinear
/// solver that relies on the Jacobian (using Newton's method).
NonlinearVariationalProblem(const Form& F,
Function& u,
const Form& J);
/// Create nonlinear variational problem with a single boundary condition.
/// The Jacobian form is not specified which requires the use of a
/// nonlinear solver that does not rely on the Jacobian.
NonlinearVariationalProblem(const Form& F,
Function& u,
const DirichletBC& bc);
/// Create nonlinear variational problem with a single boundary condition.
/// The Jacobian form is specified which allows the use of a nonlinear
/// solver that relies on the Jacobian (using Newton's method).
NonlinearVariationalProblem(const Form& F,
Function& u,
const DirichletBC& bc,
const Form& J);
/// Create nonlinear variational problem with a list of boundary conditions.
/// The Jacobian form is not specified which requires the use of a
/// nonlinear solver that does not rely on the Jacobian.
NonlinearVariationalProblem(const Form& F,
Function& u,
std::vector<const DirichletBC*> bcs);
/// Create nonlinear variational problem with a list of boundary conditions.
/// The Jacobian form is specified which allows the use of a nonlinear
/// solver that relies on the Jacobian (using Newton's method).
NonlinearVariationalProblem(const Form& F,
Function& u,
std::vector<const DirichletBC*> bcs,
const Form& J);
/// Create nonlinear variational problem, shared pointer version.
/// The Jacobian form is not specified which requires the use of a
/// nonlinear solver that does not rely on the Jacobian.
NonlinearVariationalProblem(boost::shared_ptr<const Form> F,
boost::shared_ptr<Function> u,
std::vector<boost::shared_ptr<const DirichletBC> > bcs);
/// Create nonlinear variational problem, shared pointer version.
/// The Jacobian form is specified which allows the use of a nonlinear
/// solver that relies on the Jacobian (using Newton's method).
NonlinearVariationalProblem(boost::shared_ptr<const Form> F,
boost::shared_ptr<Function> u,
std::vector<boost::shared_ptr<const DirichletBC> > bcs,
boost::shared_ptr<const Form> J);
/// Set the bounds for bound constrained solver
void set_bounds(boost::shared_ptr<const GenericVector> lb,
boost::shared_ptr<const GenericVector> ub);
/// Set the bounds for bound constrained solver
void set_bounds(const GenericVector& lb,
const GenericVector& ub);
/// Set the bounds for bound constrained solver
void set_bounds(boost::shared_ptr<const Function> lb_func,
boost::shared_ptr<const Function> ub_func);
/// Set the bounds for bound constrained solver
void set_bounds(const Function& lb_func,
const Function& ub_func);
/// Return residual form
boost::shared_ptr<const Form> residual_form() const;
/// Return Jacobian form
boost::shared_ptr<const Form> jacobian_form() const;
/// Return solution variable
boost::shared_ptr<Function> solution();
/// Return solution variable (const version)
boost::shared_ptr<const Function> solution() const;
/// Return boundary conditions
std::vector<boost::shared_ptr<const DirichletBC> > bcs() const;
/// Return trial space
boost::shared_ptr<const FunctionSpace> trial_space() const;
/// Return test space
boost::shared_ptr<const FunctionSpace> test_space() const;
/// Return lower bound
boost::shared_ptr<const GenericVector> lower_bound() const;
/// Return upper bound
boost::shared_ptr<const GenericVector> upper_bound() const;
/// Check whether Jacobian has been defined
bool has_jacobian() const;
/// Check whether lower bound has been defined
bool has_lower_bound() const;
/// Check whether upper bound have has defined
bool has_upper_bound() const;
private:
// Check forms
void check_forms() const;
// The residual form
boost::shared_ptr<const Form> _F;
// The Jacobian form (pointer may be zero if not provided)
boost::shared_ptr<const Form> _J;
// The solution
boost::shared_ptr<Function> _u;
// The boundary conditions
std::vector<boost::shared_ptr<const DirichletBC> > _bcs;
// The lower and upper bounds (pointers may be zero if not provided)
boost::shared_ptr<const GenericVector> _lb;
boost::shared_ptr<const GenericVector> _ub;
};
}
#endif
|