Boundary condition definition class. More...

#include <geometry.hpp>

Public Member Functions
	Bound (bound_e type, double value)
	Constructor for constant value boundary. More...

	Bound (bound_e type, const CallbackFunctorD_V *functor)
	Constructor for varying value boundary. More...

	Bound (std::istream &is)
	Constructor for loading boundary condition from a file. More...

bound_e	type (void) const
	Return boundary type. More...

void	set_value (double value)
	Set constant boundary value. More...

double	value (void) const
	Return constant boundary value. More...

double	value (const Vec3D &x) const
	Return boundary value at x. More...

bool	is_constant () const
	Return if boundary value is constant. More...

void	save (std::ostream &os) const
	Saves data to stream os. More...

Friends
std::ostream &	operator<< (std::ostream &os, const Bound &b)
	Outputting to stream. More...

Detailed Description

Boundary condition definition class.

Contains boundary condition type and numerical boundary value or a pointer to a callback functor providing the boundary value as a function of coordinates (x,y,z). Dirichlet here means fixed, preset potential at the boundary

$\phi = \phi_0.$

Neumann here means that the first derivative of the potential with respect to the unit outward normal (out of solid into the vacuum) of the surface is preset

$- \frac{\partial \phi}{\partial \vec{n}} = - \sum_i n_i \frac{\partial \phi}{\partial x_i} = q_0.$

Constructor & Destructor Documentation

◆ Bound() [1/3]

Bound::Bound	(	bound_e	type,
		double	value
	)

Constructor for constant value boundary.

◆ Bound() [2/3]

Bound::Bound	(	bound_e	type,
		const CallbackFunctorD_V *	functor
	)

Constructor for varying value boundary.

◆ Bound() [3/3]

Bound::Bound ( std::istream & is )

Constructor for loading boundary condition from a file.

Member Function Documentation

◆ is_constant()

bool Bound::is_constant ( ) const

Return if boundary value is constant.

Returns true if boundary value is constant and false if it is a function of location.

◆ save()

void Bound::save ( std::ostream & os ) const

Saves data to stream os.

◆ set_value()

void Bound::set_value ( double value )

Set constant boundary value.

◆ type()

bound_e Bound::type ( void ) const

Return boundary type.

◆ value() [1/2]

double Bound::value ( const Vec3D & x ) const

Return boundary value at x.

◆ value() [2/2]

double Bound::value ( void ) const

Return constant boundary value.

This function works only if boundary value is constant. Otherwise throws an error.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		const Bound &	b
	)

friend

Outputting to stream.

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

Navigation

Public Member Functions

Friends