Sources¶
-
class
casingSimulations.sources.
BaseCasingSrc
(**kwargs)¶ Bases:
casingSimulations.base.BaseCasing
The base class for sources. Inherit this to attach properties.Required Properties:
- directory (
String
): Working directory, a unicode string, Default: . - filename (
String
): filename to serialize properties to, a unicode string, Default: Source.json - meshGenerator (
BaseMeshGenerator
): mesh generator instance, an instance of BaseMeshGenerator - modelParameters (
Wholespace
): casing parameters, an instance of Wholespace - version (
String
): version of the software, a unicode string, Default: 0.0.4
-
casing_a
¶ inner radius of the casing
-
filename
¶ filename (
String
): filename to serialize properties to, a unicode string, Default: Source.json
-
freqs
¶ frequencies to consider
-
mesh
¶ discretize mesh
-
meshGenerator
¶ meshGenerator (
BaseMeshGenerator
): mesh generator instance, an instance of BaseMeshGenerator
-
modelParameters
¶ modelParameters (
Wholespace
): casing parameters, an instance of Wholespace
-
srcList
¶ Source List
-
src_a
¶ location of the a-electrode
-
src_b
¶ location of the b-electrode
- directory (
-
class
casingSimulations.sources.
DownHoleCasingSrc
(**kwargs)¶ Bases:
casingSimulations.sources.DownHoleTerminatingSrc
Source that is coupled to the casing down-hole and has a return electrode at the surface.
param CasingSimulations.Model.CasingProperties modelParameters: a casing properties instance param discretize.CylMesh mesh: a cylindrical mesh Required Properties:
- directory (
String
): Working directory, a unicode string, Default: . - filename (
String
): filename to serialize properties to, a unicode string, Default: Source.json - meshGenerator (
BaseMeshGenerator
): mesh generator instance, an instance of BaseMeshGenerator - modelParameters (
Wholespace
): casing parameters, an instance of Wholespace - version (
String
): version of the software, a unicode string, Default: 0.0.4
-
downhole_electrode
¶ Down-hole horizontal part of the wire, coupled to the casing
-
plot
(ax=None)¶ Plot the source.
-
s_e
¶ Source current density on faces
- directory (
-
class
casingSimulations.sources.
DownHoleTerminatingSrc
(**kwargs)¶ Bases:
casingSimulations.sources.BaseCasingSrc
A source that terminates down-hole. It is not coupled to the casing
param CasingSimulations.Model.CasingProperties modelParameters: a casing properties instance param discretize.BaseMesh mesh: a discretize mesh Required Properties:
- directory (
String
): Working directory, a unicode string, Default: . - filename (
String
): filename to serialize properties to, a unicode string, Default: Source.json - meshGenerator (
BaseMeshGenerator
): mesh generator instance, an instance of BaseMeshGenerator - modelParameters (
Wholespace
): casing parameters, an instance of Wholespace - version (
String
): version of the software, a unicode string, Default: 0.0.4
-
plot
(ax=None)¶ Plot the source.
-
s_e
¶ Source List
-
src_a_closest
¶ closest face to where we want the return current electrode
-
src_b_closest
¶ closest face to where we want the return current electrode
-
surface_electrode
¶ Return electrode on the surface
-
surface_wire
¶ Horizontal part of the wire that runs along the surface (one cell above) from the center of the well to the return electrode
-
surface_wire_direction
¶
-
wire_in_borehole
¶ Indices of the verically directed wire inside of the borehole. It goes through the center of the well
- directory (
-
class
casingSimulations.sources.
HorizontalElectricDipole
(**kwargs)¶ Bases:
casingSimulations.sources.BaseCasingSrc
A horizontal electric dipoleRequired Properties:
- directory (
String
): Working directory, a unicode string, Default: . - filename (
String
): filename to serialize properties to, a unicode string, Default: Source.json - meshGenerator (
BaseMeshGenerator
): mesh generator instance, an instance of BaseMeshGenerator - modelParameters (
Wholespace
): casing parameters, an instance of Wholespace - version (
String
): version of the software, a unicode string, Default: 0.0.4
-
plot
(ax=None)¶ Plot the source.
-
s_e
¶ electric source term used to build the right hand side of the maxwell system
-
src_a_closest
¶ closest face to where we want the return current electrode
-
src_b_closest
¶ closest face to where we want the return current electrode
-
surface_wire
¶ Horizontal part of the wire that runs along the surface (one cell above) from the center of the well to the return electrode
-
surface_wire_direction
¶ direction of the source wire
- directory (
-
class
casingSimulations.sources.
TopCasingSrc
(**kwargs)¶ Bases:
casingSimulations.sources.DownHoleTerminatingSrc
Source that has one electrode coupled to the top of the casing, one return electrode and a wire in between. This source is set up to live on faces.
param discretize.CylMesh mesh: the cylindrical simulation mesh param CasingSimulations modelParameters: Casing parameters object Required Properties:
- directory (
String
): Working directory, a unicode string, Default: . - filename (
String
): filename to serialize properties to, a unicode string, Default: Source.json - meshGenerator (
BaseMeshGenerator
): mesh generator instance, an instance of BaseMeshGenerator - modelParameters (
Wholespace
): casing parameters, an instance of Wholespace - version (
String
): version of the software, a unicode string, Default: 0.0.4
-
plot
(ax=None)¶ plot the source on the mesh.
-
s_e
¶ source list
-
surface_wire
¶ indices of the wire that runs along the surface
-
tophole_electrode
¶ Indices of the electrode that is grounded on the top of the casing
- directory (
-
class
casingSimulations.sources.
VerticalElectricDipole
(**kwargs)¶ Bases:
casingSimulations.sources.BaseCasingSrc
A vertical electric dipole. It is not coupled to the casing
param CasingSimulations.Model.CasingProperties modelParameters: a casing properties instance param discretize.BaseMesh mesh: a discretize mesh Required Properties:
- directory (
String
): Working directory, a unicode string, Default: . - filename (
String
): filename to serialize properties to, a unicode string, Default: Source.json - meshGenerator (
BaseMeshGenerator
): mesh generator instance, an instance of BaseMeshGenerator - modelParameters (
Wholespace
): casing parameters, an instance of Wholespace - version (
String
): version of the software, a unicode string, Default: 0.0.4
-
plot
(ax=None)¶ Plot the source.
-
s_e
¶ Source List
-
src_a_closest
¶ closest face to where we want the return current electrode
-
src_b_closest
¶ closest face to where we want the return current electrode
-
wire_in_borehole
¶ Indices of the verically directed wire inside of the borehole. It goes through the center of the well
- directory (