PorousFlowPolyLineSink

A PorousFlowPolyLineSink is a special case of the general line sink in which a polyline (represented by a sequence of points) acts as a sink or source in the model. Please see sinks for an extended discussion and examples.

Input Parameters

  • PorousFlowDictatorThe UserObject that holds the list of PorousFlow variable names

    C++ Type:UserObjectName

    Options:

    Description:The UserObject that holds the list of PorousFlow variable names

  • SumQuantityUOUser Object of type=PorousFlowSumQuantity in which to place the total outflow from the line sink for each time step.

    C++ Type:UserObjectName

    Options:

    Description:User Object of type=PorousFlowSumQuantity in which to place the total outflow from the line sink for each time step.

  • variableThe name of the variable that this kernel operates on

    C++ Type:NonlinearVariableName

    Options:

    Description:The name of the variable that this kernel operates on

  • fluxesTuple of flux values (measured in kg.m^-1.s^-1 if no 'use_*' are employed). These flux values are multiplied by the line-segment length to achieve a flux in kg.s^-1. A piecewise-linear fit is performed to the (p_or_t_vals,flux) pairs to obtain the flux at any arbitrary pressure (or temperature). If a quad-point pressure is less than the first pressure value, the first flux value is used. If quad-point pressure exceeds the final pressure value, the final flux value is used. This flux is OUT of the medium: hence positive values of flux means this will be a SINK, while negative values indicate this flux will be a SOURCE.

    C++ Type:std::vector

    Options:

    Description:Tuple of flux values (measured in kg.m^-1.s^-1 if no 'use_*' are employed). These flux values are multiplied by the line-segment length to achieve a flux in kg.s^-1. A piecewise-linear fit is performed to the (p_or_t_vals,flux) pairs to obtain the flux at any arbitrary pressure (or temperature). If a quad-point pressure is less than the first pressure value, the first flux value is used. If quad-point pressure exceeds the final pressure value, the final flux value is used. This flux is OUT of the medium: hence positive values of flux means this will be a SINK, while negative values indicate this flux will be a SOURCE.

  • point_fileThe file containing the coordinates of the points and their weightings that approximate the line sink. The physical meaning of the weightings depend on the scenario, eg, they may be borehole radii. Each line in the file must contain a space-separated weight and coordinate, viz r x y z. For boreholes, the last point in the file is defined as the borehole bottom, where the borehole pressure is bottom_pressure. If your file contains just one point, you must also specify the line_length and line_direction parameters. Note that you will get segementation faults if your points do not lie within your mesh!

    C++ Type:std::string

    Options:

    Description:The file containing the coordinates of the points and their weightings that approximate the line sink. The physical meaning of the weightings depend on the scenario, eg, they may be borehole radii. Each line in the file must contain a space-separated weight and coordinate, viz r x y z. For boreholes, the last point in the file is defined as the borehole bottom, where the borehole pressure is bottom_pressure. If your file contains just one point, you must also specify the line_length and line_direction parameters. Note that you will get segementation faults if your points do not lie within your mesh!

  • p_or_t_valsTuple of pressure (or temperature) values. Must be monotonically increasing.

    C++ Type:std::vector

    Options:

    Description:Tuple of pressure (or temperature) values. Must be monotonically increasing.

Required Parameters

  • function_ofpressureModifying functions will be a function of either pressure and permeability (eg, for boreholes that pump fluids) or temperature and thermal conductivity (eg, for boreholes that pump pure heat with no fluid flow)

    Default:pressure

    C++ Type:MooseEnum

    Options:pressure temperature

    Description:Modifying functions will be a function of either pressure and permeability (eg, for boreholes that pump fluids) or temperature and thermal conductivity (eg, for boreholes that pump pure heat with no fluid flow)

  • line_direction0 0 1Line direction. Note this is only used if there is only one point in the point_file.

    Default:0 0 1

    C++ Type:libMesh::VectorValue

    Options:

    Description:Line direction. Note this is only used if there is only one point in the point_file.

  • use_mobilityFalseMultiply the flux by the fluid mobility

    Default:False

    C++ Type:bool

    Options:

    Description:Multiply the flux by the fluid mobility

  • mass_fraction_componentThe index corresponding to a fluid component. If supplied, the flux will be multiplied by the nodal mass fraction for the component

    C++ Type:unsigned int

    Options:

    Description:The index corresponding to a fluid component. If supplied, the flux will be multiplied by the nodal mass fraction for the component

  • fluid_phase0The fluid phase whose pressure (and potentially mobility, enthalpy, etc) controls the flux to the line sink. For p_or_t=temperature, and without any use_*, this parameter is irrelevant

    Default:0

    C++ Type:unsigned int

    Options:

    Description:The fluid phase whose pressure (and potentially mobility, enthalpy, etc) controls the flux to the line sink. For p_or_t=temperature, and without any use_*, this parameter is irrelevant

  • use_relative_permeabilityFalseMultiply the flux by the fluid relative permeability

    Default:False

    C++ Type:bool

    Options:

    Description:Multiply the flux by the fluid relative permeability

  • use_internal_energyFalseMultiply the flux by the fluid internal energy

    Default:False

    C++ Type:bool

    Options:

    Description:Multiply the flux by the fluid internal energy

  • line_length0Line length. Note this is only used if there is only one point in the point_file.

    Default:0

    C++ Type:double

    Options:

    Description:Line length. Note this is only used if there is only one point in the point_file.

  • use_enthalpyFalseMultiply the flux by the fluid enthalpy

    Default:False

    C++ Type:bool

    Options:

    Description:Multiply the flux by the fluid enthalpy

Optional Parameters

  • vector_tagsnontimeThe tag for the vectors this Kernel should fill

    Default:nontime

    C++ Type:MultiMooseEnum

    Options:nontime time

    Description:The tag for the vectors this Kernel should fill

  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

    C++ Type:std::vector

    Options:

    Description:The extra tags for the vectors this Kernel should fill

  • matrix_tagssystemThe tag for the matrices this Kernel should fill

    Default:system

    C++ Type:MultiMooseEnum

    Options:nontime system

    Description:The tag for the matrices this Kernel should fill

  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

    C++ Type:std::vector

    Options:

    Description:The extra tags for the matrices this Kernel should fill

Tagging Parameters

  • drop_duplicate_pointsTrueBy default points added to a DiracKernel are dropped if a point at the same locationhas been added before. If this option is set to false duplicate points are retainedand contribute to residual and Jacobian.

    Default:True

    C++ Type:bool

    Options:

    Description:By default points added to a DiracKernel are dropped if a point at the same locationhas been added before. If this option is set to false duplicate points are retainedand contribute to residual and Jacobian.

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

    C++ Type:std::vector

    Options:

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Options:

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

Input Files