Poisson::BoundaryConditions::Robin< Dim > Class Template Reference

Impose Robin boundary conditions $au+b{n}_i{\mathrm{\nabla }}^{i}u=c$. The boundary condition is imposed as Neumann-type (i.e. on $n_i{\mathrm{\nabla }}^{i}u$) if $|b|>0$ and as Dirichlet-type (i.e. on $u$) if $b=0$. More...

#include <Robin.hpp>

Classes
struct	Constant
struct	DirichletWeight
struct	NeumannWeight

Public Types
using	options = implementation defined
using	argument_tags = implementation defined
using	volume_tags = implementation defined
using	argument_tags_linearized = implementation defined
using	volume_tags_linearized = implementation defined

Public Member Functions
	Robin (const Robin &)=default
Robin &	operator= (const Robin &)=default
	Robin (Robin &&)=default
Robin &	operator= (Robin &&)=default
std::unique_ptr< domain::BoundaryConditions::BoundaryCondition >	get_clone () const override
	Robin (double dirichlet_weight, double neumann_weight, double constant, const Options::Context &context={})
double	dirichlet_weight () const
double	neumann_weight () const
double	constant () const
std::vector< elliptic::BoundaryConditionType >	boundary_condition_types () const override
void	apply (gsl::not_null< Scalar< DataVector > * > field, gsl::not_null< Scalar< DataVector > * > n_dot_field_gradient, const tnsr::i< DataVector, Dim > &deriv_field) const
void	apply_linearized (gsl::not_null< Scalar< DataVector > * > field_correction, gsl::not_null< Scalar< DataVector > * > n_dot_field_gradient_correction, const tnsr::i< DataVector, Dim > &deriv_field_correction) const
void	pup (PUP::er &p) override
Public Member Functions inherited from elliptic::BoundaryConditions::BoundaryCondition< Dim >
	BoundaryCondition (const BoundaryCondition &)=default
	BoundaryCondition (BoundaryCondition &&)=default
BoundaryCondition &	operator= (const BoundaryCondition &)=default
BoundaryCondition &	operator= (BoundaryCondition &&)=default
virtual std::vector< elliptic::BoundaryConditionType >	boundary_condition_types () const =0
Public Member Functions inherited from domain::BoundaryConditions::BoundaryCondition
	BoundaryCondition (BoundaryCondition &&)=default
BoundaryCondition &	operator= (BoundaryCondition &&)=default
	BoundaryCondition (const BoundaryCondition &)=default
BoundaryCondition &	operator= (const BoundaryCondition &)=default
	BoundaryCondition (CkMigrateMessage *const msg)
	WRAPPED_PUPable_abstract (BoundaryCondition)
virtual auto	get_clone () const -> std::unique_ptr< BoundaryCondition >=0

Static Public Attributes
static constexpr Options::String	help
Static Public Attributes inherited from elliptic::BoundaryConditions::BoundaryCondition< Dim >
static constexpr size_t	volume_dim = Dim

Detailed Description

template<size_t Dim>
class Poisson::BoundaryConditions::Robin< Dim >

Impose Robin boundary conditions $au+b{n}_i{\mathrm{\nabla }}^{i}u=c$. The boundary condition is imposed as Neumann-type (i.e. on $n_i{\mathrm{\nabla }}^{i}u$) if $|b|>0$ and as Dirichlet-type (i.e. on $u$) if $b=0$.

Member Function Documentation

boundary_condition_types()

template<size_t Dim>

std::vector< elliptic::BoundaryConditionType > Poisson::BoundaryConditions::Robin< Dim >::boundary_condition_types ( ) const

inlineoverridevirtual

Implements elliptic::BoundaryConditions::BoundaryCondition< Dim >.

get_clone()

template<size_t Dim>

std::unique_ptr< domain::BoundaryConditions::BoundaryCondition > Poisson::BoundaryConditions::Robin< Dim >::get_clone ( ) const

inlineoverridevirtual

Implements domain::BoundaryConditions::BoundaryCondition.

Member Data Documentation

help

template<size_t Dim>

constexpr Options::String Poisson::BoundaryConditions::Robin< Dim >::help

staticconstexpr

Initial value:

=
      "Robin boundary conditions a * u + b * n_i grad(u)^i = c. The boundary "
      "condition is imposed as Neumann-type (i.e. on n_i grad(u)^i) if abs(b) "
      "> 0 and as Dirichlet-type (i.e. on u) if b = 0."

---

The documentation for this class was generated from the following file:

• src/Elliptic/Systems/Poisson/BoundaryConditions/Robin.hpp