GeochemistryConsoleOutput

This Output writes information to the console regarding the geochemical system (defined by the geochemistry_reactor) at a particular point that is defined by a NearestNodeNumber UserObject. It is quite verbose since it provides information about molalities, free masses, bulk compositions, surface characteristics and Nernst information for all relevant species, as well as descriptive characteristics such as temperature, pH, and ionic strength. It should therefore be used with caution otherwise your std::out will rapidly fill up, but it is useful for understanding and debugging models.

Usually this Output is added using Actions such as the TimeIndependentReactionSolver and the TimeDependentReactionSolver.

Advanced users may wish to add these objects manually to their input files. Here is an example:

[Outputs<<<{"href": "../../syntax/Outputs/index.html"}>>>]
  [specially_added]
    type = GeochemistryConsoleOutput<<<{"description": "Outputs results from a GeochemistryReactor at a particular point", "href": "GeochemistryConsoleOutput.html"}>>>
    geochemistry_reactor<<<{"description": "The name of the GeochemistryReactor UserObject"}>>> = reactor_name
    precision<<<{"description": "Precision for printing values"}>>> = 8 # 8 digits of precision
    mol_cutoff<<<{"description": "Information regarding species with molalities less than this amount will not be outputted"}>>> = 1E-8 # species with molality or mole-number lower than this are not outputted
    solver_info<<<{"description": "Print information (to the console) from the solver including residuals, swaps, etc"}>>> = true
    nearest_node_number_UO<<<{"description": "The NearestNodeNumber UserObject that defines the physical point at which to query the GeochemistryReactor"}>>> = nearest_node
    execute_on<<<{"description": "The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html."}>>> = 'final' # just output at the end of the simulation
  []
[]
(modules/geochemistry/test/tests/geochemistry_console_output/console.i)

Input Parameters

  • geochemistry_reactorThe name of the GeochemistryReactor UserObject

    C++ Type:UserObjectName

    Controllable:No

    Description:The name of the GeochemistryReactor UserObject

  • nearest_node_number_UOThe NearestNodeNumber UserObject that defines the physical point at which to query the GeochemistryReactor

    C++ Type:UserObjectName

    Controllable:No

    Description:The NearestNodeNumber UserObject that defines the physical point at which to query the GeochemistryReactor

Required Parameters

  • mol_cutoff1e-40Information regarding species with molalities less than this amount will not be outputted

    Default:1e-40

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Information regarding species with molalities less than this amount will not be outputted

  • precision4Precision for printing values

    Default:4

    C++ Type:unsigned int

    Controllable:No

    Description:Precision for printing values

  • solver_infoFalsePrint information (to the console) from the solver including residuals, swaps, etc

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Print information (to the console) from the solver including residuals, swaps, etc

  • stoichiometry_tolerance1e-06if abs(any stoichiometric coefficient) < stoi_tol then it is set to zero, and so will not appear in the output

    Default:1e-06

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:if abs(any stoichiometric coefficient) < stoi_tol then it is set to zero, and so will not appear in the output

  • use_displacedFalseEnable/disable the use of the displaced mesh for outputting

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Enable/disable the use of the displaced mesh for outputting

Optional Parameters

  • additional_execute_onThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

    C++ Type:ExecFlagEnum

    Options:XFEM_MARK, FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, FINAL, FAILED, CUSTOM

    Controllable:No

    Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

  • execute_onINITIAL TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

    Default:INITIAL TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:XFEM_MARK, FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, FINAL, FAILED, CUSTOM

    Controllable:No

    Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

Execution Scheduling Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

Advanced Parameters

  • end_stepTime step at which this output object stop operating

    C++ Type:int

    Controllable:No

    Description:Time step at which this output object stop operating

  • end_timeTime at which this output object stop operating

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Time at which this output object stop operating

  • min_simulation_time_interval0The minimum simulation time between output steps

    Default:0

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The minimum simulation time between output steps

  • simulation_time_interval1.79769e+308The target simulation time interval (in seconds) at which to output

    Default:1.79769e+308

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The target simulation time interval (in seconds) at which to output

  • start_stepTime step at which this output object begins to operate

    C++ Type:int

    Controllable:No

    Description:Time step at which this output object begins to operate

  • start_timeTime at which this output object begins to operate

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Time at which this output object begins to operate

  • sync_onlyFalseOnly export results at sync times

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Only export results at sync times

  • sync_timesTimes at which the output and solution is forced to occur

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:Times at which the output and solution is forced to occur

  • sync_times_objectTimes object providing the times at which the output and solution is forced to occur

    C++ Type:TimesName

    Controllable:No

    Description:Times object providing the times at which the output and solution is forced to occur

  • time_step_interval1The interval (number of time steps) at which output occurs. Unless explicitly set, the default value of this parameter is set to infinity if the wall_time_interval is explicitly set.

    Default:1

    C++ Type:unsigned int

    Controllable:No

    Description:The interval (number of time steps) at which output occurs. Unless explicitly set, the default value of this parameter is set to infinity if the wall_time_interval is explicitly set.

  • time_tolerance1e-14Time tolerance utilized checking start and end times

    Default:1e-14

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Time tolerance utilized checking start and end times

  • wall_time_interval1.79769e+308The target wall time interval (in seconds) at which to output

    Default:1.79769e+308

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The target wall time interval (in seconds) at which to output

Timing And Frequency Of Output Parameters

Input Files