#include <dirichlet_boundaries.h>

Public Member Functions
	DirichletBoundary (const std::set< boundary_id_type > &b_in, const std::vector< unsigned int > &variables_in, const FunctionBase< Number > f_in, const FunctionBase< Gradient > g_in=NULL)
	DirichletBoundary (const std::set< boundary_id_type > &b_in, const std::vector< unsigned int > &variables_in, const FunctionBase< Number > &f_in)
	DirichletBoundary (const std::set< boundary_id_type > &b_in, const std::vector< unsigned int > &variables_in, const FunctionBase< Number > &f_in, const FunctionBase< Gradient > &g_in)
	DirichletBoundary (const std::set< boundary_id_type > &b_in, const std::vector< unsigned int > &variables_in, const System &f_sys_in, const FEMFunctionBase< Number > f_in, const FEMFunctionBase< Gradient > g_in=NULL)
	DirichletBoundary (const std::set< boundary_id_type > &b_in, const std::vector< unsigned int > &variables_in, const System &f_sys_in, const FEMFunctionBase< Number > &f_in)
	DirichletBoundary (const std::set< boundary_id_type > &b_in, const std::vector< unsigned int > &variables_in, const System &f_sys_in, const FEMFunctionBase< Number > &f_in, const FEMFunctionBase< Gradient > &g_in)
	DirichletBoundary (const DirichletBoundary &dirichlet_in)
Public Attributes
std::set< boundary_id_type >	b
std::vector< unsigned int >	variables
UniquePtr< FunctionBase< Number > >	f
UniquePtr< FunctionBase < Gradient > >	g
UniquePtr< FEMFunctionBase < Number > >	f_fem
UniquePtr< FEMFunctionBase < Gradient > >	g_fem
const System *	f_system

Detailed Description

This class allows one to associate dirichlet boundary values with a given set of mesh boundary ids and system variable ids.

Dirichlet values must be supplied as the input function "f"; when using some specialized elements, gradient values must be supplied via the input function "g".

Dirichlet functions are allowed to return NaN; if this is encountered, then the degree of freedom values in a patch around the location of the returned NaN will be left unconstrained. E.g. a NaN on a boundary edge in 3D would leave that edge and the two adjoining face interiors unconstrained, but would still permit the other edge and node DoFs around those faces to be constrained.

Definition at line 64 of file dirichlet_boundaries.h.

Constructor & Destructor Documentation

libMesh::DirichletBoundary::DirichletBoundary	(	const std::set< boundary_id_type > &	b_in,
		const std::vector< unsigned int > &	variables_in,
		const FunctionBase< Number > *	f_in,
		const FunctionBase< Gradient > *	g_in = `NULL`
	)		`[inline]`

Definition at line 67 of file dirichlet_boundaries.h.

References f, g, and libMesh::libmesh_assert().

                                                               :
    b(b_in),
    variables(variables_in),
    f(f_in ? f_in->clone() : UniquePtr<FunctionBase<Number> >()),
    g(g_in ? g_in->clone() : UniquePtr<FunctionBase<Gradient> >()),
    f_fem(UniquePtr<FEMFunctionBase<Number> >()),
    g_fem(UniquePtr<FEMFunctionBase<Gradient> >()),
    f_system(NULL)
  {
    libmesh_assert(f.get());
    f->init();
    if (g.get())
      g->init();
  }

libMesh::DirichletBoundary::DirichletBoundary	(	const std::set< boundary_id_type > &	b_in,
		const std::vector< unsigned int > &	variables_in,
		const FunctionBase< Number > &	f_in
	)		`[inline]`

Definition at line 85 of file dirichlet_boundaries.h.

References f.

                                                      :
    b(b_in),
    variables(variables_in),
    f(f_in.clone()),
    g(UniquePtr<FunctionBase<Gradient> >()),
    f_fem(UniquePtr<FEMFunctionBase<Number> >()),
    g_fem(UniquePtr<FEMFunctionBase<Gradient> >()),
    f_system(NULL)
  {
    f->init();
  }

libMesh::DirichletBoundary::DirichletBoundary	(	const std::set< boundary_id_type > &	b_in,
		const std::vector< unsigned int > &	variables_in,
		const FunctionBase< Number > &	f_in,
		const FunctionBase< Gradient > &	g_in
	)		`[inline]`

Definition at line 100 of file dirichlet_boundaries.h.

References f, and g.

                                                        :
    b(b_in),
    variables(variables_in),
    f(f_in.clone()),
    g(g_in.clone()),
    f_fem(UniquePtr<FEMFunctionBase<Number> >()),
    g_fem(UniquePtr<FEMFunctionBase<Gradient> >()),
    f_system(NULL)
  {
    f->init();
    g->init();
  }

libMesh::DirichletBoundary::DirichletBoundary	(	const std::set< boundary_id_type > &	b_in,
		const std::vector< unsigned int > &	variables_in,
		const System &	f_sys_in,
		const FEMFunctionBase< Number > *	f_in,
		const FEMFunctionBase< Gradient > *	g_in = `NULL`
	)		`[inline]`

Definition at line 117 of file dirichlet_boundaries.h.

References f_fem, and libMesh::libmesh_assert().

                                                                  :
    b(b_in),
    variables(variables_in),
    f(UniquePtr<FunctionBase<Number> >()),
    g(UniquePtr<FunctionBase<Gradient> >()),
    f_fem(f_in ? f_in->clone() : UniquePtr<FEMFunctionBase<Number> >()),
    g_fem(g_in ? g_in->clone() : UniquePtr<FEMFunctionBase<Gradient> >()),
    f_system(&f_sys_in)
  {
    libmesh_assert(f_fem.get());
  }

libMesh::DirichletBoundary::DirichletBoundary	(	const std::set< boundary_id_type > &	b_in,
		const std::vector< unsigned int > &	variables_in,
		const System &	f_sys_in,
		const FEMFunctionBase< Number > &	f_in
	)		`[inline]`

Definition at line 133 of file dirichlet_boundaries.h.

                                                         :
    b(b_in),
    variables(variables_in),
    f(UniquePtr<FunctionBase<Number> >()),
    g(UniquePtr<FunctionBase<Gradient> >()),
    f_fem(f_in.clone()),
    g_fem(UniquePtr<FEMFunctionBase<Gradient> >()),
    f_system(&f_sys_in)
  {
  }

libMesh::DirichletBoundary::DirichletBoundary	(	const std::set< boundary_id_type > &	b_in,
		const std::vector< unsigned int > &	variables_in,
		const System &	f_sys_in,
		const FEMFunctionBase< Number > &	f_in,
		const FEMFunctionBase< Gradient > &	g_in
	)		`[inline]`

Definition at line 148 of file dirichlet_boundaries.h.

                                                           :
    b(b_in),
    variables(variables_in),
    f(UniquePtr<FunctionBase<Number> >()),
    g(UniquePtr<FunctionBase<Gradient> >()),
    f_fem(f_in.clone()),
    g_fem(g_in.clone()),
    f_system(&f_sys_in)
  {
  }

libMesh::DirichletBoundary::DirichletBoundary ( const DirichletBoundary & dirichlet_in ) [inline]

Definition at line 166 of file dirichlet_boundaries.h.

References f, f_fem, f_system, g, g_fem, and libMesh::libmesh_assert().

                                                            :
    b(dirichlet_in.b),
    variables(dirichlet_in.variables),
    f(dirichlet_in.f.get() ?
      dirichlet_in.f->clone() : UniquePtr<FunctionBase<Number> >()),
    g(dirichlet_in.g.get() ?
      dirichlet_in.g->clone() : UniquePtr<FunctionBase<Gradient> >()),
    f_fem(dirichlet_in.f_fem.get() ?
      dirichlet_in.f_fem->clone() : UniquePtr<FEMFunctionBase<Number> >()),
    g_fem(dirichlet_in.g_fem.get() ?
      dirichlet_in.g_fem->clone() : UniquePtr<FEMFunctionBase<Gradient> >()),
    f_system(dirichlet_in.f_system)
  {
    libmesh_assert(f.get() || f_fem.get());
    libmesh_assert(!(f.get() && f_fem.get()));
    libmesh_assert(!(f.get() && g_fem.get()));
    libmesh_assert(!(f_fem.get() && g.get()));
    libmesh_assert(!(f_fem.get() && !f_system));
    if (f.get())
      f->init();
    if (g.get())
      g->init();
  }