Loading...
Searching...
No Matches
NonlinearVariationalProblem.h
// 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.
#ifndef __NONLINEAR_VARIATIONAL_PROBLEM_H
#define __NONLINEAR_VARIATIONAL_PROBLEM_H
#include <memory>
#include <vector>
#include <dolfin/common/Hierarchical.h>
namespace dolfin
{
// Forward declarations
class Form;
class Function;
class FunctionSpace;
class DirichletBC;
class GenericVector;
class NonlinearVariationalProblem
: public Hierarchical<NonlinearVariationalProblem>
{
public:
NonlinearVariationalProblem(std::shared_ptr<const Form> F,
std::shared_ptr<Function> u,
std::vector<std::shared_ptr<const DirichletBC>> bcs,
std::shared_ptr<const Form> J=nullptr);
void set_bounds(const Function& lb_func, const Function& ub_func);
void set_bounds(std::shared_ptr<const GenericVector> lb,
std::shared_ptr<const GenericVector> ub);
std::shared_ptr<const Form> residual_form() const;
std::shared_ptr<const Form> jacobian_form() const;
std::shared_ptr<Function> solution();
std::shared_ptr<const Function> solution() const;
std::vector<std::shared_ptr<const DirichletBC>> bcs() const;
std::shared_ptr<const FunctionSpace> trial_space() const;
std::shared_ptr<const FunctionSpace> test_space() const;
std::shared_ptr<const GenericVector> lower_bound() const;
std::shared_ptr<const GenericVector> upper_bound() const;
bool has_jacobian() const;
bool has_lower_bound() const;
bool has_upper_bound() const;
private:
// Check forms
void check_forms() const;
// The residual form
std::shared_ptr<const Form> _residual;
// The Jacobian form (pointer may be null if not provided)
std::shared_ptr<const Form> _jacobian;
// The solution
std::shared_ptr<Function> _u;
// The boundary conditions
std::vector<std::shared_ptr<const DirichletBC>> _bcs;
// The lower and upper bounds (pointers may be null if not
// provided)
std::shared_ptr<const GenericVector> _lb;
std::shared_ptr<const GenericVector> _ub;
};
}
#endif
dolfin::DirichletBC
Interface for setting (strong) Dirichlet boundary conditions.
Definition DirichletBC.h:125
dolfin::Form
Base class for UFC code generated by FFC for DOLFIN with option -l.
Definition Form.h:86
dolfin::FunctionSpace
Definition FunctionSpace.h:54
dolfin::Function
Definition Function.h:66
dolfin::GenericVector
This class defines a common interface for vectors.
Definition GenericVector.h:48
dolfin::Hierarchical< NonlinearVariationalProblem >::Hierarchical
Hierarchical(NonlinearVariationalProblem &self)
Definition Hierarchical.h:48
dolfin::NonlinearVariationalProblem::test_space
std::shared_ptr< const FunctionSpace > test_space() const
Return test space.
Definition NonlinearVariationalProblem.cpp:92
dolfin::NonlinearVariationalProblem::jacobian_form
std::shared_ptr< const Form > jacobian_form() const
Return Jacobian form.
Definition NonlinearVariationalProblem.cpp:63
dolfin::NonlinearVariationalProblem::has_lower_bound
bool has_lower_bound() const
Check whether lower bound has been defined.
Definition NonlinearVariationalProblem.cpp:117
dolfin::NonlinearVariationalProblem::lower_bound
std::shared_ptr< const GenericVector > lower_bound() const
Return lower bound.
Definition NonlinearVariationalProblem.cpp:99
dolfin::NonlinearVariationalProblem::bcs
std::vector< std::shared_ptr< const DirichletBC > > bcs() const
Return boundary conditions.
Definition NonlinearVariationalProblem.cpp:79
dolfin::NonlinearVariationalProblem::residual_form
std::shared_ptr< const Form > residual_form() const
Return residual form.
Definition NonlinearVariationalProblem.cpp:58
dolfin::NonlinearVariationalProblem::upper_bound
std::shared_ptr< const GenericVector > upper_bound() const
Return upper bound.
Definition NonlinearVariationalProblem.cpp:106
dolfin::NonlinearVariationalProblem::trial_space
std::shared_ptr< const FunctionSpace > trial_space() const
Return trial space.
Definition NonlinearVariationalProblem.cpp:85
dolfin::NonlinearVariationalProblem::solution
std::shared_ptr< Function > solution()
Return solution variable.
Definition NonlinearVariationalProblem.cpp:68
dolfin::NonlinearVariationalProblem::has_jacobian
bool has_jacobian() const
Check whether Jacobian has been defined.
Definition NonlinearVariationalProblem.cpp:112
dolfin::NonlinearVariationalProblem::NonlinearVariationalProblem
NonlinearVariationalProblem(std::shared_ptr< const Form > F, std::shared_ptr< Function > u, std::vector< std::shared_ptr< const DirichletBC > > bcs, std::shared_ptr< const Form > J=nullptr)
Definition NonlinearVariationalProblem.cpp:30
dolfin::NonlinearVariationalProblem::has_upper_bound
bool has_upper_bound() const
Check whether upper bound have has defined.
Definition NonlinearVariationalProblem.cpp:122
dolfin::NonlinearVariationalProblem::set_bounds
void set_bounds(const Function &lb_func, const Function &ub_func)
Set the bounds for bound constrained solver.
Definition NonlinearVariationalProblem.cpp:42
dolfin
Definition adapt.h:30