Langevin C++ source

Loading...
Searching...
No Matches
Parameters Struct Reference

Container for BaseLangevin integrator parameters. More...

`#include <langevin_parameters.hpp>`

## Public Member Functions
| Parameters (const double t_final, const double dx, const double dt, const int rs, const GridDimension gd, const int_vec_t gs, const gt_vec_t gts, const bc_vec_t bcs, const dbl_vec_t bcv, const InitialCondition ic, const dbl_vec_t icv, const IntegrationMethod im)
std::string | report (GridDimension gd)
std::string | report (GridTopology gt)
std::string | report (GridDimension gd, gt_vec_t gts)
std::string | report (BoundaryCondition bc)
std::string | report (GridDimension gd, bc_vec_t bcs)
std::string | report (InitialCondition ic)
std::string | report (IntegrationMethod im)
void | print ()

## Public Attributes
const double | t_final =0
const double | dx =0
const double | dt =0
const int | random_seed =0
const GridDimension | grid_dimension =GridDimension::D1
const int_vec_t | grid_size ={}
int | n_cells =0
int | n_x =0
int | n_y =0
int | n_z =0
const gt_vec_t | grid_topologies = {}
const bc_vec_t | boundary_conditions = {}
const dbl_vec_t | bc_values ={}
const InitialCondition | initial_condition =InitialCondition::RANDOM_UNIFORM
const dbl_vec_t | ic_values ={}
const IntegrationMethod | integration_method =IntegrationMethod::RUNGE_KUTTA

## Detailed Description

Container for BaseLangevin integrator parameters.

Definition at line 20 of file langevin_parameters.hpp.

## Constructor & Destructor Documentation

## ◆ Parameters()

Parameters::Parameters | ( | const double | t_final,
|  | const double | dx,
|  | const double | dt,
|  | const int | rs,
|  | const GridDimension | gd,
|  | const int_vec_t | gs,
|  | const gt_vec_t | gts,
|  | const bc_vec_t | bcs,
|  | const dbl_vec_t | bcv,
|  | const InitialCondition | ic,
|  | const dbl_vec_t | icv,
|  | const IntegrationMethod | im )
| inline

Definition at line 41 of file langevin_parameters.hpp.

## Member Function Documentation

## ◆ print()

void Parameters::print | ( |  | ) |
| inline

Definition at line 156 of file langevin_parameters.hpp.

## ◆ report() [1/7]

std::string Parameters::report | ( | BoundaryCondition | bc | ) |
| inline

Definition at line 106 of file langevin_parameters.hpp.

## ◆ report() [2/7]

std::string Parameters::report | ( | GridDimension | gd | ) |
| inline

Definition at line 73 of file langevin_parameters.hpp.

## ◆ report() [3/7]

std::string Parameters::report | ( | GridDimension | gd,
|  | bc_vec_t | bcs )
| inline

Definition at line 115 of file langevin_parameters.hpp.

## ◆ report() [4/7]

std::string Parameters::report | ( | GridDimension | gd,
|  | gt_vec_t | gts )
| inline

Definition at line 90 of file langevin_parameters.hpp.

## ◆ report() [5/7]

std::string Parameters::report | ( | GridTopology | gt | ) |
| inline

Definition at line 82 of file langevin_parameters.hpp.

## ◆ report() [6/7]

std::string Parameters::report | ( | InitialCondition | ic | ) |
| inline

Definition at line 137 of file langevin_parameters.hpp.

## ◆ report() [7/7]

std::string Parameters::report | ( | IntegrationMethod | im | ) |
| inline

Definition at line 147 of file langevin_parameters.hpp.

## Member Data Documentation

## ◆ bc_values

const dbl_vec_t Parameters::bc_values ={}

Definition at line 35 of file langevin_parameters.hpp.

## ◆ boundary_conditions

const bc_vec_t Parameters::boundary_conditions = {}

Definition at line 34 of file langevin_parameters.hpp.

## ◆ dt

const double Parameters::dt =0

Definition at line 25 of file langevin_parameters.hpp.

## ◆ dx

const double Parameters::dx =0

Definition at line 24 of file langevin_parameters.hpp.

## ◆ grid_dimension

const GridDimension Parameters::grid_dimension =GridDimension::D1

Definition at line 27 of file langevin_parameters.hpp.

## ◆ grid_size

const int_vec_t Parameters::grid_size ={}

Definition at line 28 of file langevin_parameters.hpp.

## ◆ grid_topologies

const gt_vec_t Parameters::grid_topologies = {}

Definition at line 33 of file langevin_parameters.hpp.

## ◆ ic_values

const dbl_vec_t Parameters::ic_values ={}

Definition at line 37 of file langevin_parameters.hpp.

## ◆ initial_condition

const InitialCondition Parameters::initial_condition =InitialCondition::RANDOM_UNIFORM

Definition at line 36 of file langevin_parameters.hpp.

## ◆ integration_method

const IntegrationMethod Parameters::integration_method =IntegrationMethod::RUNGE_KUTTA

Definition at line 38 of file langevin_parameters.hpp.

## ◆ n_cells

int Parameters::n_cells =0

Definition at line 29 of file langevin_parameters.hpp.

## ◆ n_x

int Parameters::n_x =0

Definition at line 30 of file langevin_parameters.hpp.

## ◆ n_y

int Parameters::n_y =0

Definition at line 31 of file langevin_parameters.hpp.

## ◆ n_z

int Parameters::n_z =0

Definition at line 32 of file langevin_parameters.hpp.

## ◆ random_seed

const int Parameters::random_seed =0

Definition at line 26 of file langevin_parameters.hpp.

## ◆ t_final

const double Parameters::t_final =0

Definition at line 23 of file langevin_parameters.hpp.

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

- cplusplus/core/langevin_parameters.hpp