Neumann Class Reference

#include <Neumann.hpp>

Inheritance diagram for Neumann:

[legend]

Collaboration diagram for Neumann:

[legend]

List of all members.

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

---

Detailed Description

Definition at line 45 of file Neumann.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

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

Constructor

Parameters:

	g	the conormal derivative
	unknownNumber	unknown number

Definition at line 81 of file Neumann.hpp.

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

Neumann::Neumann

(

const Neumann &

N

)

[inline]

Copy constructor

Parameters:

N

given Neumann

Definition at line 94 of file Neumann.hpp.

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

Neumann::~Neumann

(

)

[inline]

Destructor

Definition at line 105 of file Neumann.hpp.

  {
    ;
  }

---

Member Function Documentation

ConstReferenceCounting<ScalarFunctionBase> Neumann::g

(

)

const [inline]

Read-only access to the second member

Returns:

Definition at line 60 of file Neumann.hpp.

References __g.

Referenced by BoundaryConditionSurfaceMeshAssociation::addPDEBoundaryConditionAndMesh().

  {
    return __g;
  }

std::string Neumann::typeName

(

)

const [inline, virtual]

Gets the condition name

Returns:

"Neumann"

Implements PDECondition.

Definition at line 70 of file Neumann.hpp.

  {
    return "Neumann";
  }

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> Neumann::__g [private]

The function to impose as a Neumann boundary condition.

Definition at line 51 of file Neumann.hpp.

Referenced by g().

---

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

• Neumann.hpp