Class EJ_Tortuosity

Inheritance Relationships

Base Type

Class Documentation

class EJ_Tortuosity : private MaterialProperty

A class for computing tortuosity using the explicit jump method.

An EJ_Tortuosity object is created and used by the compute_EJTortuosity() functions.

See also

compute_EJTortuosity()

Public Functions

EJ_Tortuosity(puma::Workspace *segWS, puma::Matrix<double> *C, int voidSpace, char dir, double solverTol, int solverMaxIt, bool print, int numThreads)

A constructor which takes in the parameters used in calculating tortuosity from the explicit jump method.

Parameters
  • segWS – a segmented workspace containing the domain.

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

  • voidLabel – is an int which specified the void phase in the Segmented Workspace (usually 0).

  • 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.

puma::Vec3<double> compute()

computes the tortuosity using the parameters specified when constructing the object.

Returns

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