Class documentation of Concepts

Loading...
Searching...
No Matches

#include <boundary.hh>

Inheritance diagram for concepts::Boundary:
concepts::OutputOperator

Public Types

enum  boundaryTypes {
  FREE = 0 , DIRICHLET , NEUMANN , CONNECT ,
  SPHERESURFACEQUAD , MAX_TYPE
}
 The different boundary condition types. More...
 

Public Member Functions

 Boundary ()
 
 Boundary (const enum boundaryTypes type)
 
 Boundary (const enum boundaryTypes type, const Formula< Real > &frm)
 
 Boundary (const enum boundaryTypes type, const char *frm)
 
 Boundary (const Boundary &bnd)
 Copy constructor.
 
enum boundaryTypes type () const
 Returns the type of the boundary condition.
 
std::string typeStr () const
 Return the type of the boundary condition as output string.
 
virtual Boundaryoperator= (const Boundary &bnd)
 Assignment operator.
 
bool isNull ()
 
Real operator() (const Real x, const Real t=0.0) const
 
Real operator() (const Real2d &x, const Real t=0.0) const
 
Real operator() (const Real3d &x, const Real t=0.0) const
 

Protected Member Functions

virtual std::ostream & info (std::ostream &os) const
 Returns information in an output stream.
 

Detailed Description

Class to describe an element of the boundary. A boundary has a type (Neumann, Dirichlet) and a function associated.

Boundary conditions of type Robin are not yet implemented.

It is possible to use this class in the following way:

Boundary(Boundary::NEUMANN, ParsedFormula("(x)"));

since the ParsedFormula is cloned (ie. it is copied) before the temporary object is destroyed.

Author
Philipp Frauenfelder, 2000
Examples
elasticity2D_tutorial.cc, howToGetStarted.cc, hpFEM2d-simple.cc, hpFEM2d.cc, hpFEM3d-EV.cc, inhomDirichletBCs.cc, inhomNeumannBCs.cc, linearDG1d.cc, linearFEM1d-simple.cc, linearFEM1d.cc, and parallelizationTutorial.cc.

Definition at line 35 of file boundary.hh.

Member Enumeration Documentation

◆ boundaryTypes

The different boundary condition types.

Definition at line 38 of file boundary.hh.

Constructor & Destructor Documentation

◆ Boundary() [1/4]

concepts::Boundary::Boundary ( )

Default constructor. Initializes the type to FREE.

◆ Boundary() [2/4]

concepts::Boundary::Boundary ( const enum boundaryTypes  type)

Constructor. The type of the boundary condition must be one of FREE, DIRICHLET, NEUMANN or CONNECT. In this constructor, no formula can be given. It is always evaluated to 0 by default.

◆ Boundary() [3/4]

concepts::Boundary::Boundary ( const enum boundaryTypes  type,
const Formula< Real > &  frm 
)

Constructor. The type of the boundary condition must be one of FREE, DIRICHLET or NEUMANN.

Parameters
typeBoundary type
frmFormula (can be a temporary object since it is copied)

◆ Boundary() [4/4]

concepts::Boundary::Boundary ( const enum boundaryTypes  type,
const char frm 
)

Constructor. The type of the boundary condition must be one of FREE, DIRICHLET or NEUMANN. The formula can be given as a string which will be used to create a ParsedFormula.

Parameters
typeBoundary type
frmFormula as a string

Member Function Documentation

◆ info()

virtual std::ostream & concepts::Boundary::info ( std::ostream &  os) const
protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::OutputOperator.

◆ isNull()

bool concepts::Boundary::isNull ( )
inline

Definition at line 82 of file boundary.hh.

◆ operator()() [1/3]

Real concepts::Boundary::operator() ( const Real  x,
const Real  t = 0.0 
) const

Application operator. Calculates the value of the boundary function at a specific point.

◆ operator()() [2/3]

Real concepts::Boundary::operator() ( const Real2d x,
const Real  t = 0.0 
) const

Application operator. Calculates the value of the boundary function at a specific point.

◆ operator()() [3/3]

Real concepts::Boundary::operator() ( const Real3d x,
const Real  t = 0.0 
) const

Application operator. Calculates the value of the boundary function at a specific point.

◆ type()

enum boundaryTypes concepts::Boundary::type ( ) const
inline

Returns the type of the boundary condition.

Definition at line 74 of file boundary.hh.


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