langevin_enums.hpp File Reference

Enumerated parameter options for BaseLangevin integrator. More...

Go to the source code of this file.

Enumerations
enum class	GridDimension { D1 = 1 , D2 = 2 , D3 = 3 }
	Density field grid dimension: only 1D or 2D grids implemented so far. More...
enum class	GridEdge { lx = 1 , ux = 2 , ly = 3 , uy = 4 }
	Classifier for grid edges used in boundary condition handling. More...
enum class	GridTopology { BOUNDED = 1 , PERIODIC = 2 }
	Grid boundary topology: only bounded or periodic (along all edges) implemented so far. More...
enum class	BoundaryCondition { FLOATING = 1 , FIXED_VALUE = 2 , FIXED_FLUX = 3 }
	Grid boundary condition: floating/fixed value/fixed flux; application equally to all edges only for now. More...
enum class	InitialCondition { RANDOM_UNIFORM = 1 , RANDOM_GAUSSIAN = 2 , CONSTANT_VALUE = 3 , SINGLE_SEED = 4 }
	Grid density field initial condition: random uniform or Gaussian variates; constant everywhere; or central seed value. More...
enum class	IntegrationMethod { EULER = 1 , RUNGE_KUTTA = 2 }
	Deterministic integration method: default is 4th-order Runge-Kutta; can be explicit Euler. More...

Detailed Description

Enumerated parameter options for BaseLangevin integrator.

Parameter options as enums, used in both C++ and Python, used to choose e.g. suitable grid geometries, topologies, boundary and initial conditions, and the lowest-level integration method.

Definition in file langevin_enums.hpp.

Enumeration Type Documentation

BoundaryCondition

enum class BoundaryCondition

strong

Grid boundary condition: floating/fixed value/fixed flux; application equally to all edges only for now.

Definition at line 40 of file langevin_enums.hpp.

GridDimension

enum class GridDimension

strong

Density field grid dimension: only 1D or 2D grids implemented so far.

Definition at line 14 of file langevin_enums.hpp.

GridEdge

enum class GridEdge

strong

Classifier for grid edges used in boundary condition handling.

Definition at line 22 of file langevin_enums.hpp.

GridTopology

enum class GridTopology

strong

Grid boundary topology: only bounded or periodic (along all edges) implemented so far.

Definition at line 33 of file langevin_enums.hpp.

InitialCondition

enum class InitialCondition

strong

Grid density field initial condition: random uniform or Gaussian variates; constant everywhere; or central seed value.

Definition at line 48 of file langevin_enums.hpp.

IntegrationMethod

enum class IntegrationMethod

strong

Deterministic integration method: default is 4th-order Runge-Kutta; can be explicit Euler.

Definition at line 57 of file langevin_enums.hpp.