skip ci

Author: amaurigmartins

.gitignore

@@ -45,3 +45,6 @@ showcase
 papers
 sprint
 */fem_output
+.github/*.md
+.github/instructions
+.github/prompts

Project.toml

@@ -15,9 +15,12 @@ DisplayAs = "0b91fe84-8a4c-11e9-3e1d-67c38462b6d6"
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
 EzXML = "8f5d6c58-4d21-5cfd-889c-e3ad7ee6a615"
 ForceImport = "9dda63f9-cce7-5873-89fa-eccbb2fffcde"
+GetDP = "dbfd83e6-7aba-450b-9c2b-93ccd973023a"
 Gmsh = "705231aa-382f-11e9-3f0c-b7cb4346fdeb"
 JSON3 = "0f8b85d8-7281-11e9-16c2-39a750bddbf1"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
+LoggingExtras = "e6f89c97-d47a-5376-807f-9c37f3926c36"
 Measurements = "eff96d63-e80a-5855-80a2-b1b0885c5ab7"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 PlotlyJS = "f0f68f2c-4968-5e81-91da-67840de0976a"
@@ -39,10 +42,13 @@ DisplayAs = "0.1.6"
 DocStringExtensions = "0.9.3"
 EzXML = "1.2.0"
 ForceImport = "0.0.3"
+GetDP = "0.1.0"
 Gmsh = "0.3.1"
 HypertextLiteral = "0.9.5"
 JSON3 = "1.14.2"
 LinearAlgebra = "1.11.0"
+Logging = "1.11.0"
+LoggingExtras = "1.1.0"
 Measurements = "2.11.0"
 Pkg = "1.11.0"
 PlotlyJS = "0.18.15"

docs/src/conventions.md

@@ -362,18 +362,18 @@ A workspace:
 Each module follows a consistent type hierarchy:
 
 ```julia
-AbstractProblemDefinition
-  ├── FEMProblemDefinition
+AbstractProblemFormulation
+  ├── FEMFormulation :> {FEMDarwin, FEMElectrodynamics, ...}
   ├── AbstractFDEMFormulation :> {CPEarth, CIGRE, ...}
   ├── AbstractEHEMFormulation :> {EnforceLayer, EquivalentSigma, ...}
   ├── ...
   └── [Other specialized formulations, concrete or abstract]
 
-AbstractSolverMethod
-  ├── FEMSolver
-  ├── EMTSolver
+FormulationOptions
+  ├── FEMOptions
+  ├── EMTOptions
   ├── ...
-  └── [Other specialized solvers]
+  └── [Other specialized options sets]
 
 AbstractWorkspace
   ├── FEMWorkspace
@@ -416,7 +416,7 @@ This pattern ensures clean separation of concerns, making the code more maintain
 
 State is managed exclusively through the Workspace, which contains:
 
-1. **Configuration state**: Original system, formulation, and solver.
+1. **Configuration state**: Original system, formulation, and opts.
 2. **Entity state**: Collections of typed entities.
 3. **Lookup maps**: Efficient mappings between entities and properties.
 4. **Processing state**: Temporary calculation state.
@@ -428,7 +428,7 @@ This centralized approach eliminates global state and ensures thread safety.
 
 The FEMTools module exemplifies this pattern:
 
-- `FEMProblemDefinition`: Physics parameters for FEM simulation.
+- `FEMFormulation`: Physics parameters for FEM simulation.
 - `FEMSolver`: Execution parameters for meshing and solving.
 - `FEMWorkspace`: Central state container for all FEM operations.
 - Entity types: Typed data containers for different geometric elements.

examples/tutorial2.jl

@@ -344,7 +344,7 @@ In this section, the cable design is examined and the calculated parameters are
 =#
 
 # Compare with datasheet information (R, L, C values):
-core_df = cabledesign_todf(cable_design, :core)
+core_df = cabledesign_todf(cable_design, :baseparams)
 
 # Obtain the equivalent electromagnetic properties of the cable:
 components_df = cabledesign_todf(cable_design, :components)
@@ -402,8 +402,8 @@ y0 = -1
 xa, ya, xb, yb, xc, yc = trifoil_formation(x0, y0, 0.035)
 
 # Initialize the `LineCableSystem` with the first cable (phase A):
-cabledef = CableDef(cable_design, xa, ya, Dict("core" => 1, "sheath" => 0, "jacket" => 0))
-cable_system = LineCableSystem("tutorial", 20.0, earth_params, 1000.0, cabledef)
+cablepos = CablePosition(cable_design, xa, ya, Dict("core" => 1, "sheath" => 0, "jacket" => 0))
+cable_system = LineCableSystem("tutorial", 1000.0, cablepos)
 
 # Add remaining cables (phases B and C):
 addto_linecablesystem!(cable_system, cable_design, xb, yb,
@@ -438,8 +438,8 @@ The final step showcases how to export the model for electromagnetic transient s
 =#
 
 # Export to PSCAD input file:
-output_file = joinpath(@__DIR__, "$(cable_system.case_id)_export.pscx")
-export_file = export_pscad_lcp(cable_system, file_name=output_file);
+output_file = joinpath(@__DIR__, "$(cable_system.system_id)_export.pscx")
+export_file = export_pscad_lcp(cable_system, earth_params, file_name=output_file);
 
 #=
 ## Conclusion

examples/tutorial3.jl

@@ -21,8 +21,8 @@ y0 = -1
 xa, ya, xb, yb, xc, yc = trifoil_formation(x0, y0, 0.035)
 
 # Initialize the `LineCableSystem` with the first cable (phase A):
-cabledef = CableDef(cable_design, xa, ya, Dict("core" => 1, "sheath" => 0, "jacket" => 0))
-cable_system = LineCableSystem("tutorial", 20.0, earth_params, 1000.0, cabledef)
+cablepos = CablePosition(cable_design, xa, ya, Dict("core" => 1, "sheath" => 0, "jacket" => 0))
+cable_system = LineCableSystem("tutorial", 1000.0, cablepos)
 
 # Add remaining cables (phases B and C):
 addto_linecablesystem!(cable_system, cable_design, xb, yb,
@@ -35,36 +35,45 @@ addto_linecablesystem!(
 
 display(cable_system)
 
-# Create a FEMProblemDefinition with custom parameters
+# Define a LineParametersProblem with the cable system and earth model
+problem = LineParametersProblem(
+    cable_system,
+    temperature=20.0,  # Operating temperature
+    earth_props=earth_params,
+    frequencies=[50.0],  # Frequency for the analysis
+)
+
+# Create a FEMFormulation with custom mesh definitions
 domain_radius = 5.0
-problem = FEMProblemDefinition(
+formulation = FEMFormulation(
     domain_radius=domain_radius,
-    correct_twisting=true,
+    domain_radius_inf=domain_radius * 1.25,
     elements_per_length_conductor=1,
     elements_per_length_insulator=2,
     elements_per_length_semicon=1,
     elements_per_length_interfaces=5,
     points_per_circumference=16,
-    analysis_type=[0, 1],  # Electrostatic and magnetostatic
+    analysis_type=(FEMDarwin(), FEMElectrodynamics()),
     mesh_size_min=1e-6,
     mesh_size_max=domain_radius / 5,
     mesh_size_default=domain_radius / 10,
     mesh_algorithm=5,
     materials_db=materials_db
 )
 
-# Create a FEMSolver with custom parameters
-solver = FEMSolver(
+# Define runtime FEMOptions 
+opts = FEMOptions(
     force_remesh=true,  # Force remeshing
-    run_solver=false,
+    run_solver=true,
+    overwrite_results=true,
     preview_geo=false,  # Preview geometry
-    preview_mesh=true,  # Preview the mesh
+    preview_mesh=false,  # Preview the mesh
     base_path=joinpath(@__DIR__, "fem_output"),
-    verbosity=0,  # Verbose output
-    getdp_executable=joinpath("/home/amartins/Applications/onelab-Linux64", "getdp"),  # Path to GetDP executable
+    verbosity=2,  # Verbose output
+    getdp_executable=joinpath("/home/amartins/Applications/onelab-Linux64", "getdp"), # Path to GetDP executable
 )
 
 # Run the FEM model
-workspace = run_fem_model(cable_system, problem, solver, frequency=50.0)
+@time _ = compute!(problem, formulation, opts)
 
 println("FEM model run completed.")