pydfnWorks
python wrapper for dfnWorks
pydfnworks.dfnFlow.mass_balance Namespace Reference

Functions

def get_domain ()
 
def parse_pflotran_input (pflotran_input_file)
 
def flow_rate (darcy_vel_file, boundary_file)
 
def dump_effective_perm (local_jobname, mass_rate, volume_rate, domain, direction, inflow_pressure, outflow_pressure)
 
def effective_perm (self)
 

Variables

 flow_solver
 

Function Documentation

◆ dump_effective_perm()

def pydfnworks.dfnFlow.mass_balance.dump_effective_perm (   local_jobname,
  mass_rate,
  volume_rate,
  domain,
  direction,
  inflow_pressure,
  outflow_pressure 
)
Compute the effective permeability of the DFN and write it to screen and to the file local_jobname_effective_perm.dat

Parameters
----------
    local_jobname  : string
        Jobname
    mass_rate : float
        Mass flow rate through inflow boundary
    volume_rate : float
        Volumetric flow rate through inflow boundary
    direction : string
        Primary direction of flow (x, y, or z)
    domain : dict
        Dictionary of domain sizes in x, y, z
    inflow_pressure : float
        Inflow boundary pressure
    outflow_pressure : float
        Outflow boundary pressure

Returns
-------
    None

Notes
-----
Information is written into (local_jobname)_effective_perm.txt

Definition at line 197 of file mass_balance.py.

◆ effective_perm()

def pydfnworks.dfnFlow.mass_balance.effective_perm (   self)
Computes the effective permeability of a DFN in the primary direction of flow using a steady-state PFLOTRAN solution. 

Parameters
----------
    self : object 
        DFN Class

Returns
-------
    None

Notes
-----
1. Information is written to screen and to the file self.local_jobname_effective_perm.txt
2. Currently, only PFLOTRAN solutions are supported
3. Assumes density of water 

Definition at line 288 of file mass_balance.py.

◆ flow_rate()

def pydfnworks.dfnFlow.mass_balance.flow_rate (   darcy_vel_file,
  boundary_file 
)
Calculates the flow rate across the inflow boundary

Parameters
----------
    darcy_vel_file : string
        Name of concatenated Darcy velocity file
    boundary_file : string
         ex file for the inflow boundary

Returns
-------
    mass_rate : float
        Mass flow rate across the inflow boundary
    volume_rate : float
        Volumetric flow rate across the inflow boundary

Notes
-----
None

Definition at line 132 of file mass_balance.py.

◆ get_domain()

def pydfnworks.dfnFlow.mass_balance.get_domain ( )
 Return dictionary of domain x,y,z by calling parse_params_file

Parameters
----------
    None

Returns
-------
    domain : dict
        Dictionary of domain sizes in x, y, z

Notes
-----
    parse_params_file() is in mesh_dfn_helper.py

Definition at line 17 of file mass_balance.py.

◆ parse_pflotran_input()

def pydfnworks.dfnFlow.mass_balance.parse_pflotran_input (   pflotran_input_file)
 Walk through PFLOTRAN input file and find inflow boundary, inflow and outflow pressure, and direction of flow

Parameters
----------
    pflotran_input_file : string
        Name of PFLOTRAN input file

Returns
-------
    inflow_pressure : double
        Inflow Pressure boundary condition
    outflow_pressure : float
        Outflow pressure boundary condition
    inflow_file : string
        Name of inflow boundary .ex file 
    direction : string 
        Primary direction of flow x, y, or z

Notes
-----
Currently only works for Dirichlet Boundary Conditions

Definition at line 37 of file mass_balance.py.

Variable Documentation

◆ flow_solver

pydfnworks.dfnFlow.mass_balance.flow_solver

Definition at line 308 of file mass_balance.py.