Fourrier Class Reference

#include <Fourrier.hpp>

Inheritance diagram for Fourrier:

[legend]

Collaboration diagram for Fourrier:

[legend]

List of all members.

Public Types
enum	Type { dirichlet, neumann, fourrier }
	allowed types. More...
Public Member Functions
ConstReferenceCounting < ScalarFunctionBase >	alpha () const
ConstReferenceCounting < ScalarFunctionBase >	g () const
std::string	typeName () const
	Fourrier (ConstReferenceCounting< ScalarFunctionBase > ualpha, ConstReferenceCounting< ScalarFunctionBase > ug, const size_t &unknownNumber)
	Fourrier (const Fourrier &F)
	~Fourrier ()
const size_t &	unknownNumber () const
const PDECondition::Type &	type () const
Private Attributes
ConstReferenceCounting < ScalarFunctionBase >	__Alpha
ConstReferenceCounting < ScalarFunctionBase >	__g
Friends
std::ostream &	operator<< (std::ostream &os, const PDECondition &bc)

---

Detailed Description

Definition at line 43 of file Fourrier.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

Fourrier::Fourrier	(	ConstReferenceCounting< ScalarFunctionBase >	ualpha,
		ConstReferenceCounting< ScalarFunctionBase >	ug,
		const size_t &	unknownNumber
	)			[inline]

Constructs the condition

Parameters:

	ualpha
	ug
	unknownNumber	the unknown number

Definition at line 95 of file Fourrier.hpp.

    : PDECondition(PDECondition::fourrier,
                   unknownNumber),
      __Alpha(ualpha),
      __g(ug)
  {
    ;
  }

Fourrier::Fourrier

(

const Fourrier &

F

)

[inline]

Copy constructor

Parameters:

F

given Fourrier condition

Definition at line 111 of file Fourrier.hpp.

    : PDECondition(F),
      __Alpha(F.__Alpha),
      __g(F.__g)
  {
    ;
  }

Fourrier::~Fourrier

(

)

[inline]

Destructor

Definition at line 123 of file Fourrier.hpp.

  {
    ;
  }

---

Member Function Documentation

ConstReferenceCounting<ScalarFunctionBase> Fourrier::alpha

(

)

const [inline]

Read only access to the mass coefficient

Returns:

Definition at line 61 of file Fourrier.hpp.

References __Alpha.

Referenced by BoundaryConditionSurfaceMeshAssociation::addPDEBoundaryConditionAndMesh().

  {
    return __Alpha;
  }

ConstReferenceCounting<ScalarFunctionBase> Fourrier::g

(

)

const [inline]

Rad-only access to the second member

Returns:

Definition at line 73 of file Fourrier.hpp.

References __g.

Referenced by BoundaryConditionSurfaceMeshAssociation::addPDEBoundaryConditionAndMesh().

  {
    return __g;
  }

std::string Fourrier::typeName

(

)

const [inline, virtual]

Gets the type name of the condition

Returns:

"Fourrier"

Implements PDECondition.

Definition at line 83 of file Fourrier.hpp.

  {
    return "Fourrier";
  }

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> Fourrier::__Alpha [private]

The coeficient

Definition at line 48 of file Fourrier.hpp.

Referenced by alpha().

ConstReferenceCounting<ScalarFunctionBase> Fourrier::__g [private]

The function to impose as a Fourrier Boundary Condition

Definition at line 51 of file Fourrier.hpp.

Referenced by g().

---

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

• Fourrier.hpp