Function puma::compute_FVTortuosity

Function Documentation

puma::Vec3<double> puma::compute_FVTortuosity(Workspace *grayWS, puma::Matrix<double> *C, puma::Cutoff cutoff, std::string sideBC, std::string solverType, char dir, double solverTol, int solverMaxIt, bool print, int numThreads = 0)

computes tortuosity from a grayscale workspace using the explicit jump method.

Parameters
  • grayWS – a grayscale workspace containing the domain.

  • C – a pointer to a puma matrix to store the resulting Concentration field.

  • lowVoid – is the lowest grayscale value in the void phase.

  • highVoid – is the lowest grayscale value in the void phase.

  • dir – a char specifying which direction to run the simulation in (should be ‘x’, ‘y’, or ‘z’).

  • solverTol – a double specifying the convergence criterion for the iterative solver used.

  • solverMaxIt – an integer specifying the maximum number of iterations the solver may execute before exiting.

  • print – a boolean which specifies whether the the number of iterations and residual are printed after each iteration of the solver.

  • numThreads – an integer which specifies the number of threads used for the simulation.

Returns

a puma vector containing the tortuosity in the x, y, and z directions.