OpenMEEG
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
OpenMEEG::Domain Class Reference

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

#include <domain.h>

Public Types

typedef std::vector< SimpleDomainBoundaries
 

Public Member Functions

 Domain (const std::string &dname="")
 
 ~Domain ()
 
Boundariesboundaries ()
 Boundaries of the domain.
 
const Boundariesboundaries () const
 
std::string & name ()
 The name of the domain.
 
const std::string & name () const
 
void set_conductivity (const double c)
 The conductivity of the domain.
 
bool has_conductivity () const
 
const double & conductivity () const
 
void info (const bool outermost=false) const
 Print information about the domain.
 
bool contains (const Mesh &m) const
 
bool contains (const Vect3 &point) const
 Does this point belongs to the domain ?
 
int mesh_orientation (const Mesh &m) const
 

Detailed Description

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

In addition the domain is named and has a conductivity.

Definition at line 57 of file domain.h.

Member Typedef Documentation

◆ Boundaries

Definition at line 60 of file domain.h.

Constructor & Destructor Documentation

◆ Domain()

OpenMEEG::Domain::Domain ( const std::string &  dname = "")
inline

Definition at line 62 of file domain.h.

◆ ~Domain()

OpenMEEG::Domain::~Domain ( )
inline

Definition at line 63 of file domain.h.

Member Function Documentation

◆ boundaries() [1/2]

Boundaries & OpenMEEG::Domain::boundaries ( )
inline

Boundaries of the domain.

Definition at line 67 of file domain.h.

◆ boundaries() [2/2]

const Boundaries & OpenMEEG::Domain::boundaries ( ) const
inline

Definition at line 68 of file domain.h.

◆ name() [1/2]

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

The name of the domain.

Definition at line 72 of file domain.h.

◆ name() [2/2]

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

Definition at line 73 of file domain.h.

◆ set_conductivity()

void OpenMEEG::Domain::set_conductivity ( const double  c)
inline

The conductivity of the domain.

Definition at line 77 of file domain.h.

◆ has_conductivity()

bool OpenMEEG::Domain::has_conductivity ( ) const
inline

Definition at line 78 of file domain.h.

◆ conductivity()

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

Definition at line 79 of file domain.h.

◆ info()

void OpenMEEG::Domain::info ( const bool  outermost = false) const

Print information about the domain.

Parameters
outermostspecifies if the domain is the outer domain (the geometry knows this information).

◆ contains() [1/2]

bool OpenMEEG::Domain::contains ( const Mesh m) const
inline

Definition at line 87 of file domain.h.

◆ contains() [2/2]

bool OpenMEEG::Domain::contains ( const Vect3 point) 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 towards the inside of the domain. -1 if the mesh is oriented towards the outsde of the domain. 0 otherwise (the mesh is not part of the domain boundary).

Definition at line 95 of file domain.h.


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