faunus
Public Types | Public Member Functions | Public Attributes | List of all members
Faunus::Geometry::BoundaryCondition Class Reference

A structure containing a type of boundary condition in each direction. More...

#include <geometry.h>

Public Types

using BoundaryXYZ = Eigen::Matrix< Boundary, 3, 1 >
 

Public Member Functions

Eigen::Matrix< bool, 3, 1 > isPeriodic () const
 
 BoundaryCondition (Coordinates coordinates=Coordinates::ORTHOGONAL, BoundaryXYZ boundary={Boundary::FIXED, Boundary::FIXED, Boundary::FIXED})
 

Public Attributes

Coordinates coordinates
 
BoundaryXYZ direction
 

Detailed Description

A structure containing a type of boundary condition in each direction.

A stub. It can be extended to fully json-configurable boundary conditions.

Member Function Documentation

◆ isPeriodic()

Eigen::Matrix< bool, 3, 1 > Faunus::Geometry::BoundaryCondition::isPeriodic ( ) const
Returns
Boolean matrix with true for each periodic direction

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