OpenMEEG
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
OpenMEEG::Interface Class Reference

Interface class An interface is a closed-shape composed of oriented meshes (here pointer to meshes) More...

#include <interface.h>

Inherits vector< OrientedMesh >.

Public Types

typedef Mesh::VectPTriangle VectPTriangle
 

Public Member Functions

 Interface ()
 Default Constructor. More...
 
 Interface (const std::string _name)
 Constructor from a name. More...
 
const std::string name () const
 
const bool & outermost () const
 
void set_to_outermost ()
 set all interface meshes to outermost state. More...
 
bool contains_point (const Vect3 &p) const
 
bool check (bool checked=false)
 Check the global orientation. More...
 
size_t nb_vertices () const
 
size_t nb_triangles () const
 
VectPTriangle adjacent_triangles (const Triangle &t) const
 

Private Member Functions

double compute_solid_angle (const Vect3 &p) const
 Given a point p, it computes the solid angle. More...
 

Private Attributes

std::string name_
 is "" by default More...
 
bool outermost_
 tell weather or not the interface touches the Air (Outermost) Domain. More...
 

Detailed Description

Interface class An interface is a closed-shape composed of oriented meshes (here pointer to meshes)

Definition at line 72 of file interface.h.

Member Typedef Documentation

Definition at line 76 of file interface.h.

Constructor & Destructor Documentation

OpenMEEG::Interface::Interface ( )
inline

Default Constructor.

Definition at line 79 of file interface.h.

OpenMEEG::Interface::Interface ( const std::string  _name)
inline

Constructor from a name.

Definition at line 82 of file interface.h.

Member Function Documentation

const std::string OpenMEEG::Interface::name ( ) const
inline
Returns
Interface name

Definition at line 84 of file interface.h.

const bool& OpenMEEG::Interface::outermost ( ) const
inline
Returns
true if it is the outermost interface.

Definition at line 85 of file interface.h.

void OpenMEEG::Interface::set_to_outermost ( )

set all interface meshes to outermost state.

bool OpenMEEG::Interface::contains_point ( const Vect3 p) const
Parameters
pa point
Returns
true if point is inside interface
bool OpenMEEG::Interface::check ( bool  checked = false)

Check the global orientation.

size_t OpenMEEG::Interface::nb_vertices ( ) const
inline
Returns
the total number of the interface vertices

Definition at line 91 of file interface.h.

size_t OpenMEEG::Interface::nb_triangles ( ) const
inline
Returns
the total number of the interface triangles

Definition at line 100 of file interface.h.

VectPTriangle OpenMEEG::Interface::adjacent_triangles ( const Triangle t) const
inline
Returns
the adjacent triangles

Definition at line 109 of file interface.h.

double OpenMEEG::Interface::compute_solid_angle ( const Vect3 p) const
private

Given a point p, it computes the solid angle.

Returns
should return +/- 4 PI or 0.

Member Data Documentation

std::string OpenMEEG::Interface::name_
private

is "" by default

Definition at line 122 of file interface.h.

bool OpenMEEG::Interface::outermost_
private

tell weather or not the interface touches the Air (Outermost) Domain.

Definition at line 123 of file interface.h.


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