/usr/include/dolfin/adaptivity/GenericAdaptiveVariationalSolver.h is in libdolfin-dev 1.4.0+dfsg-4.
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 | // Copyright (C) 2010--2012 Marie E. Rognes
//
// 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 Anders Logg, 2010-2011.
//
// First added: 2010-08-19
// Last changed: 2012-11-14
#ifndef __GENERIC_ADAPTIVE_VARIATIONAL_SOLVER_H
#define __GENERIC_ADAPTIVE_VARIATIONAL_SOLVER_H
#include <vector>
#include <memory>
#include <dolfin/common/Variable.h>
#include <dolfin/adaptivity/ErrorControl.h>
namespace dolfin
{
// Forward declarations
class DirichletBC;
class Form;
class Function;
class FunctionSpace;
class GoalFunctional;
class Mesh;
class Parameters;
/// An abstract class for goal-oriented adaptive solution of
/// variational problems.
///
class GenericAdaptiveVariationalSolver : public Variable
{
public:
virtual ~GenericAdaptiveVariationalSolver();
/// Solve such that the functional error is less than the given
/// tolerance. Note that each call to solve is based on the
/// leaf-node of the variational problem
///
/// *Arguments*
/// tol (double)
/// The error tolerance
void solve(const double tol);
/// Solve the primal problem. Must be overloaded in subclass.
///
/// *Returns*
/// _Function_
/// The solution to the primal problem
virtual std::shared_ptr<const Function> solve_primal() = 0;
/// Extract the boundary conditions for the primal problem. Must
/// be overloaded in subclass.
///
/// *Returns*
/// std::vector<_DirichletBC_>
/// The primal boundary conditions
virtual std::vector<std::shared_ptr<const DirichletBC> >
extract_bcs() const = 0;
/// Evaluate the goal functional. Must be overloaded in subclass.
///
/// *Arguments*
/// M (_Form_)
/// The functional to be evaluated
/// u (_Function_)
/// The function of which to evaluate the functional
///
/// *Returns*
/// double
/// The value of M evaluated at u
virtual double evaluate_goal(Form& M,
std::shared_ptr<const Function> u) const = 0;
/// Adapt the problem to other mesh. Must be overloaded in subclass.
///
/// *Arguments*
/// mesh (_Mesh_)
/// The other mesh
virtual void adapt_problem(std::shared_ptr<const Mesh> mesh) = 0;
/// Return stored adaptive data
///
/// *Returns*
/// std::vector<_Parameters_>
/// The data stored in the adaptive loop
std::vector<std::shared_ptr<Parameters> > adaptive_data() const;
/// Default parameter values:
///
/// "max_iterations" (int)
/// "max_dimension" (int)
/// "plot_mesh" (bool)
/// "save_data" (bool)
/// "data_label" (std::string)
/// "reference" (double)
/// "marking_strategy" (std::string)
/// "marking_fraction" (double)
static Parameters default_parameters()
{
Parameters p("adaptive_solver");
// Set default generic adaptive parameters
p.add("max_iterations", 50);
p.add("max_dimension", 0);
p.add("plot_mesh", false); // Useful for debugging
p.add("save_data", false);
p.add("data_label", "default/adaptivity");
p.add("reference", 0.0);
p.add("marking_strategy", "dorfler");
p.add("marking_fraction", 0.5, 0.0, 1.0);
// Set parameters for dual solver
Parameters ec_params(ErrorControl::default_parameters());
p.add(ec_params);
return p;
}
/// Present summary of all adaptive data and parameters
void summary();
protected:
// The goal functional
std::shared_ptr<Form> goal;
// Error control object
std::shared_ptr<ErrorControl> control;
// A list of adaptive data
std::vector<std::shared_ptr<Parameters> > _adaptive_data;
/// Return the number of degrees of freedom for primal problem
///
/// *Returns*
/// _std::size_t_
/// The number of degrees of freedom
virtual std::size_t num_dofs_primal() = 0;
};
}
#endif
|