OpenMEEG
Public Member Functions | Private Types | Private Attributes | List of all members
OpenMEEG::Domain Class Reference

a Domain is a vector of HalfSpace A Domain is the intersection of simple domains (of type HalfSpace). More...

#include <domain.h>

Inherits std::vector< HalfSpace >.

Public Member Functions

 Domain ()
 
 ~Domain ()
 
std::string & name ()
 The name of the domain. More...
 
const std::string & name () const
 
double & sigma ()
 The conductivity of the domain. More...
 
const double & sigma () const
 
bool & outermost ()
 Returns the outermost state of the domain. More...
 
const bool & outermost () const
 
void info () const
 print info about the domain More...
 
bool contains_point (const Vect3 &) const
 Does this point belongs to the domain ? More...
 
int mesh_orientation (const Mesh &m) const
 

Private Types

typedef std::vector< HalfSpacebase
 

Private Attributes

std::string name_
 Name of the domain. More...
 
double sigma_
 Conductivity of the domain. More...
 
bool outermost_
 Is it an outermost domain. More...
 

Detailed Description

a Domain is a vector of HalfSpace A Domain is the intersection of simple domains (of type HalfSpace).

In addition the domain is named, has conductivity and a flag saying whether or not it is the outermost domain

Definition at line 79 of file domain.h.

Member Typedef Documentation

◆ base

typedef std::vector<HalfSpace> OpenMEEG::Domain::base
private

Definition at line 81 of file domain.h.

Constructor & Destructor Documentation

◆ Domain()

OpenMEEG::Domain::Domain ( )
inline

Definition at line 85 of file domain.h.

◆ ~Domain()

OpenMEEG::Domain::~Domain ( )
inline

Definition at line 87 of file domain.h.

Member Function Documentation

◆ name() [1/2]

std::string& OpenMEEG::Domain::name ( )
inline

The name of the domain.

Definition at line 91 of file domain.h.

◆ name() [2/2]

const std::string& OpenMEEG::Domain::name ( ) const
inline

Definition at line 92 of file domain.h.

◆ sigma() [1/2]

double& OpenMEEG::Domain::sigma ( )
inline

The conductivity of the domain.

Definition at line 96 of file domain.h.

◆ sigma() [2/2]

const double& OpenMEEG::Domain::sigma ( ) const
inline

Definition at line 97 of file domain.h.

◆ outermost() [1/2]

bool& OpenMEEG::Domain::outermost ( )
inline

Returns the outermost state of the domain.

Definition at line 101 of file domain.h.

◆ outermost() [2/2]

const bool& OpenMEEG::Domain::outermost ( ) const
inline

Definition at line 102 of file domain.h.

◆ info()

void OpenMEEG::Domain::info ( ) const

print info about the domain

◆ contains_point()

bool OpenMEEG::Domain::contains_point ( const Vect3 ) const

Does this point belongs to the domain ?

◆ mesh_orientation()

int OpenMEEG::Domain::mesh_orientation ( const Mesh m) const
inline
Returns
1 if the mesh is oriented toward the domain. -1 if not 0 else (the mesh is not part of the domain boundary)

Definition at line 112 of file domain.h.

Member Data Documentation

◆ name_

std::string OpenMEEG::Domain::name_
private

Name of the domain.

Definition at line 122 of file domain.h.

◆ sigma_

double OpenMEEG::Domain::sigma_
private

Conductivity of the domain.

Definition at line 123 of file domain.h.

◆ outermost_

bool OpenMEEG::Domain::outermost_
private

Is it an outermost domain.

Definition at line 124 of file domain.h.


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