Dirichlet Class Reference

#include <Dirichlet.hpp>

Inheritance diagram for Dirichlet:

[legend]

Collaboration diagram for Dirichlet:

[legend]

List of all members.

Public Types
enum	Type { dirichlet, neumann, fourrier }
	allowed types. More...
Public Member Functions
real_t	g (const TinyVector< 3, real_t > &x) const
std::string	typeName () const
	Dirichlet (ConstReferenceCounting< ScalarFunctionBase > g, const size_t &unknownNumber)
	Dirichlet (const Dirichlet &d)
	~Dirichlet ()
const size_t &	unknownNumber () const
const PDECondition::Type &	type () const
Private Attributes
ConstReferenceCounting < ScalarFunctionBase >	__g
	The function to impose as a Dirichlet Boundary Condition.
Friends
std::ostream &	operator<< (std::ostream &os, const PDECondition &bc)

---

Detailed Description

Definition at line 36 of file Dirichlet.hpp.

---

Member Enumeration Documentation

enum PDECondition::Type [inherited]

allowed types.

Enumerator:

dirichlet
neumann
fourrier

Definition at line 39 of file PDECondition.hpp.

            {
    dirichlet,
    neumann,
    fourrier
  };

---

Constructor & Destructor Documentation

Dirichlet::Dirichlet	(	ConstReferenceCounting< ScalarFunctionBase >	g,
		const size_t &	unknownNumber
	)			[inline]

Constructor

Parameters:

	g	the dirichlet given function
	unknownNumber	the unknown function number

Definition at line 72 of file Dirichlet.hpp.

    : PDECondition(PDECondition::dirichlet,
                   unknownNumber),
      __g(g)
  {
    ;
  }

Dirichlet::Dirichlet

(

const Dirichlet &

d

)

[inline]

Copy constructor

Parameters:

d

a given dirichlet condition

Returns:

Definition at line 88 of file Dirichlet.hpp.

    : PDECondition(d),
      __g(d.__g)
  {
    ;
  }

Dirichlet::~Dirichlet

(

)

[inline]

Destructor

Definition at line 99 of file Dirichlet.hpp.

  {
    ;
  }

---

Member Function Documentation

real_t Dirichlet::g

(

const TinyVector< 3, real_t > &

x

)

const [inline]

evaluates __g at the position x

Parameters:

x

evaluation point

Returns:

Definition at line 51 of file Dirichlet.hpp.

References __g.

Referenced by BoundaryConditionCommonFEMDiscretization< MeshType, TypeOfDiscretization >::__setSecondMemberDirichlet(), BoundaryConditionDiscretizationPenalty< MeshType, TypeOfDiscretization >::__SetSecondMemberDirichlet< VectorType >::eval(), and BoundaryConditionDiscretizationElimination< MeshType, TypeOfDiscretization >::__SetSecondMemberDirichlet::eval().

  {
    return (*__g)(x);
  }

std::string Dirichlet::typeName

(

)

const [inline, virtual]

returns the name of the condition

Returns:

"Dirichlet"

Implements PDECondition.

Definition at line 61 of file Dirichlet.hpp.

  {
    return "Dirichlet";
  }

const size_t& PDECondition::unknownNumber

(

)

const [inline, inherited]

Read-only access to the unknown number

Returns:

__unknownNumber

Definition at line 64 of file PDECondition.hpp.

References PDECondition::__unknownNumber.

Referenced by BoundaryConditionSurfaceMeshAssociation::addPDEBoundaryConditionAndMesh().

  {
    return __unknownNumber;
  }

const PDECondition::Type& PDECondition::type

(

)

const [inline, inherited]

Read-only access to the type of condition

Returns:

__type

Definition at line 75 of file PDECondition.hpp.

References PDECondition::__type.

  {
    return __type;
  }

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const PDECondition &	bc
	)			[friend, inherited]

Writes the condition

Parameters:

	os	output stream
	bc	the condition to write

Returns:

os

Definition at line 115 of file PDECondition.hpp.

  {
    os << bc.typeName();
    return os;
  }

---

Member Data Documentation

ConstReferenceCounting<ScalarFunctionBase> Dirichlet::__g [private]

The function to impose as a Dirichlet Boundary Condition.

Definition at line 41 of file Dirichlet.hpp.

Referenced by g().

---

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

• Dirichlet.hpp