pydfnWorks
python wrapper for dfnWorks
pydfnworks.dfnGen.generation.gen_distributions.distr Class Reference

Public Member Functions

def __init__ (self, params, numEdistribs, numRdistribs, minFracSize)
 
def beta_distribution (self, prefix)
 
def distr (self, prefix)
 
def lognormal_dist (self, prefix)
 
def tpl_dist (self, prefix)
 
def exponential_dist (self, prefix)
 
def constant_dist (self, prefix)
 

Data Fields

 params
 
 ellipseFams
 
 rectFams
 
 numEdistribs
 
 numRdistribs
 

Detailed Description

Verifies the fracture distribution input parameters for dfnGen.

Attributes:
    params :list
        Parameters for dfnGen
    numEdistribs : int
        Number of ellipse family distributions
    numRdistribs : int
        Number of rectangle family distributions
    minFracSize : double
        Minimum fracture size

Definition at line 6 of file gen_distributions.py.

Constructor & Destructor Documentation

◆ __init__()

def pydfnworks.dfnGen.generation.gen_distributions.distr.__init__ (   self,
  params,
  numEdistribs,
  numRdistribs,
  minFracSize 
)

Definition at line 20 of file gen_distributions.py.

◆ distr()

def pydfnworks.dfnGen.generation.gen_distributions.distr.distr (   self,
  prefix 
)
Verifies "edistr" and "rdistr" making sure one distribution is defined per family and
each distribution is either 1 (log-normal), 2 (Truncated Power Law), 3 (Exponential), or 4 (constant).
Stores how many of each distrib are in use in numEdistribs or numRdistribs lists.  

Definition at line 67 of file gen_distributions.py.

References pydfnworks.dfnGen.generation.gen_distributions.distr.ellipseFams, pydfnworks.dfnGen.generation.gen_distributions.distr.numEdistribs, pydfnworks.dfnGen.generation.gen_distributions.distr.numRdistribs, and pydfnworks.dfnGen.generation.gen_distributions.distr.rectFams.

Member Function Documentation

◆ beta_distribution()

def pydfnworks.dfnGen.generation.gen_distributions.distr.beta_distribution (   self,
  prefix 
)
Verifies both the "ebetaDistribution" and "rBetaDistribution". If either contain any flags
indicating contant angle (1) then the corresponding "ebeta" and/or "rbeta" parameters are 
also verified. 

Parameters:
    prefix : str
        Indicates shapes that the beta distribution describes. 'e' if they are ellipses, 'r' if they are rectangles.

Definition at line 29 of file gen_distributions.py.

References pydfnworks.dfnGen.generation.gen_distributions.distr.ellipseFams, and pydfnworks.dfnGen.generation.gen_distributions.distr.rectFams.

◆ constant_dist()

def pydfnworks.dfnGen.generation.gen_distributions.distr.constant_dist (   self,
  prefix 
)

◆ exponential_dist()

def pydfnworks.dfnGen.generation.gen_distributions.distr.exponential_dist (   self,
  prefix 
)
Verifies parameters for exponential distribution of fractures.

Definition at line 175 of file gen_distributions.py.

References pydfnworks.dfnGen.generation.gen_distributions.distr.numEdistribs, and pydfnworks.dfnGen.generation.gen_distributions.distr.numRdistribs.

◆ lognormal_dist()

def pydfnworks.dfnGen.generation.gen_distributions.distr.lognormal_dist (   self,
  prefix 
)
Verifies all logNormal Parameters for ellipses and Rectangles.

Definition at line 96 of file gen_distributions.py.

References pydfnworks.dfnGen.generation.gen_distributions.distr.numEdistribs, and pydfnworks.dfnGen.generation.gen_distributions.distr.numRdistribs.

◆ tpl_dist()

def pydfnworks.dfnGen.generation.gen_distributions.distr.tpl_dist (   self,
  prefix 
)
Verifies parameters for truncated power law distribution of fractures.

Definition at line 146 of file gen_distributions.py.

References pydfnworks.dfnGen.generation.gen_distributions.distr.numEdistribs, and pydfnworks.dfnGen.generation.gen_distributions.distr.numRdistribs.

Field Documentation

◆ ellipseFams

◆ numEdistribs

◆ numRdistribs

◆ params

◆ rectFams


The documentation for this class was generated from the following file: