structuraid_core 0.1.1

data/lib/structuraid_core/elements/reinforcement/rebar.rb

@@ -0,0 +1,45 @@
+module StructuraidCore
+  module Elements
+    module Reinforcement
+      class Rebar < Base
+        include Utils::RebarData
+
+        attr_reader :start_hook, :end_hook, :diameter, :number, :material
+
+        def initialize(number:, material:)
+          @start_hook = nil
+          @end_hook = nil
+          @number = number
+          @material = material
+          @diameter = find_standard_diameter(rebar_number: number)
+        end
+
+        def area
+          rebar_area = Math::PI * (diameter**2) / 4
+          rebar_area.to_f
+        end
+
+        def perimeter
+          rebar_perimeter = Math::PI * diameter
+          rebar_perimeter.to_f
+        end
+
+        def add_start_hook(hook)
+          @start_hook = hook
+        end
+
+        def add_end_hook(hook)
+          @end_hook = hook
+        end
+
+        def delete_start_hook
+          @start_hook = nil
+        end
+
+        def delete_end_hook
+          @end_hook = nil
+        end
+      end
+    end
+  end
+end

data/lib/structuraid_core/elements/reinforcement/rebar_hook.rb

@@ -0,0 +1,18 @@
+module StructuraidCore
+  module Elements
+    module Reinforcement
+      class RebarHook < Base
+        include Utils::RebarData
+
+        attr_reader :angle
+
+        def initialize(number:, material:)
+          @angle = nil
+          @number = number
+          @material = material
+          @diameter = find_standard_diameter(rebar_number: number)
+        end
+      end
+    end
+  end
+end

data/lib/structuraid_core/elements/reinforcement/straight_longitudinal.rb

@@ -0,0 +1,44 @@
+module StructuraidCore
+  module Elements
+    module Reinforcement
+      class StraightLongitudinal < Base
+        attr_reader :layers
+
+        def initialize(distribution_direction:, above_middle: false)
+          @above_middle = above_middle
+          @layers = []
+          @distribution_direction = distribution_direction
+        end
+
+        def add_layer(start_location:, end_location:, amount_of_rebars:, rebar:)
+          new_layer = Elements::Reinforcement::StraightLongitudinalLayer.new(
+            start_location:,
+            end_location:,
+            amount_of_rebars:,
+            rebar:,
+            distribution_direction: @distribution_direction
+          )
+
+          new_layer.reposition(above_middle: @above_middle)
+          @layers << new_layer
+
+          new_layer
+        end
+
+        def centroid_height
+          return inertia / area unless @layers.empty?
+
+          raise Elements::Reinforcement::EmptyLayers, "can't complete centroid height calculation"
+        end
+
+        def area
+          @layers.map(&:area).reduce(:+)
+        end
+
+        def inertia
+          @layers.map(&:inertia).reduce(:+)
+        end
+      end
+    end
+  end
+end

data/lib/structuraid_core/elements/reinforcement/straight_longitudinal_layer.rb

@@ -0,0 +1,89 @@
+module StructuraidCore
+  module Elements
+    module Reinforcement
+      class StraightLongitudinalLayer < Base
+        attr_reader :rebar, :amount_of_rebars
+
+        VALID_DIRECTIONS = %i[length_1 length_2 length_3].freeze
+
+        def initialize(
+          start_location:,
+          end_location:,
+          amount_of_rebars:,
+          rebar:,
+          distribution_direction:
+        )
+          if VALID_DIRECTIONS.none?(distribution_direction)
+            raise Elements::Reinforcement::InvalidDistributionDirection.new(distribution_direction, VALID_DIRECTIONS)
+          end
+
+          @start_location = start_location
+          @end_location = end_location
+          @amount_of_rebars = amount_of_rebars
+          @rebar = rebar
+          @distribution_direction = distribution_direction
+        end
+
+        def modify_rebar_configuration(
+          amount_of_new_rebars:,
+          new_rebar:,
+          above_middle:
+        )
+
+          offset = (diameter - new_rebar.diameter) / 2
+          offset *= -1 unless above_middle
+
+          @amount_of_rebars = amount_of_new_rebars
+          @rebar = new_rebar
+
+          reposition(above_middle:, offset:)
+          @rebar
+        end
+
+        def reposition(above_middle:, offset: nil)
+          offset ||= 0.5 * diameter
+
+          [@start_location, @end_location].each do |location|
+            location.value_3 = above_middle ? location.value_3 - offset : location.value_3 + offset
+          end
+        end
+
+        def area
+          @amount_of_rebars * @rebar.area
+        end
+
+        def inertia
+          area * centroid_height
+        end
+
+        def centroid_height
+          @start_location.value_3
+        end
+
+        def diameter
+          @rebar.diameter
+        end
+
+        def length
+          vector = length_vector
+
+          vector.value_x = 0 if @distribution_direction == :length_1
+          vector.value_y = 0 if @distribution_direction == :length_2
+          vector.value_z = 0 if @distribution_direction == :length_3
+
+          vector.magnitude
+        end
+
+        private
+
+        def length_vector
+          Engineering::Vector.new(
+            value_x: @end_location.value_1 - @start_location.value_1,
+            value_y: @end_location.value_2 - @start_location.value_2,
+            value_z: @end_location.value_3 - @start_location.value_3
+          )
+        end
+      end
+    end
+  end
+end

data/lib/structuraid_core/elements/reinforcement/utils/rebar_data.rb

@@ -0,0 +1,14 @@
+module StructuraidCore
+  module Elements
+    module Reinforcement
+      module Utils
+        module RebarData
+          def find_standard_diameter(rebar_number:)
+            standard_rebar_data = DB::Base.find_standard_rebar(number: rebar_number)
+            standard_rebar_data['diameter'].to_f
+          end
+        end
+      end
+    end
+  end
+end

data/lib/structuraid_core/engineering/analysis/footing/centric_isolated.rb

@@ -0,0 +1,60 @@
+module StructuraidCore
+  module Engineering
+    module Analysis
+      module Footing
+        class CentricIsolated
+          ORTHOGONALITIES = %i[length_1 length_2].freeze
+
+          def initialize(footing:, load_from_column:, section_direction:)
+            if ORTHOGONALITIES.none?(section_direction)
+              raise Engineering::Analysis::SectionDirectionError.new(section_direction, ORTHOGONALITIES)
+            end
+
+            @footing = footing
+            @load_from_column = load_from_column
+            @section_direction = section_direction
+          end
+
+          def solicitation_load
+            solicitation * orthogonal_length
+          end
+
+          def max_shear_solicitation
+            solicitation_load * section_length
+          end
+
+          def shear_solicitation_at(distance_from_footing_center:)
+            footing_section_length = section_length
+
+            solicitation_load * (footing_section_length - distance_from_footing_center)
+          end
+
+          def bending_solicitation
+            0.25 * max_shear_solicitation * section_length
+          end
+
+          private
+
+          attr_reader :footing, :load_from_column, :section_direction
+
+          def section_length
+            footing.public_send(section_direction)
+          end
+
+          def orthogonal_length
+            footing.public_send(orthogonal_direction)
+          end
+
+          def solicitation
+            load_from_column.value / footing.horizontal_area
+          end
+
+          def orthogonal_direction
+            orthogonal = ORTHOGONALITIES - [section_direction]
+            orthogonal.last
+          end
+        end
+      end
+    end
+  end
+end

data/lib/structuraid_core/engineering/base.rb

@@ -0,0 +1,10 @@
+module StructuraidCore
+  module Engineering
+    class Base
+    end
+  end
+end
+
+require_relative 'vector'
+require_relative 'analysis/footing/centric_isolated'
+require_relative 'locations/base'

data/lib/structuraid_core/engineering/locations/absolute.rb

@@ -0,0 +1,19 @@
+module StructuraidCore
+  module Engineering
+    module Locations
+      class Absolute < Base
+        attr_accessor :value_x, :value_y, :value_z
+
+        def initialize(value_x:, value_y:, value_z:)
+          @value_x = value_x.to_f
+          @value_y = value_y.to_f
+          @value_z = value_z.to_f
+        end
+
+        def to_a
+          [@value_x, @value_y, @value_z]
+        end
+      end
+    end
+  end
+end

data/lib/structuraid_core/engineering/locations/base.rb

@@ -0,0 +1,11 @@
+module StructuraidCore
+  module Engineering
+    module Locations
+      class Base
+      end
+    end
+  end
+end
+
+require_relative 'absolute'
+require_relative 'relative'

data/lib/structuraid_core/engineering/locations/relative.rb

@@ -0,0 +1,15 @@
+module StructuraidCore
+  module Engineering
+    module Locations
+      class Relative < Base
+        attr_accessor :value_1, :value_2, :value_3
+
+        def initialize(value_1:, value_2:, value_3:)
+          @value_1 = value_1.to_f
+          @value_2 = value_2.to_f
+          @value_3 = value_3.to_f
+        end
+      end
+    end
+  end
+end

data/lib/structuraid_core/engineering/vector.rb

@@ -0,0 +1,35 @@
+module StructuraidCore
+  module Engineering
+    class Vector < Base
+      attr_accessor :value_x, :value_y, :value_z
+
+      def self.with_value(value:, direction:)
+        new(
+          value_x: value.to_f * direction[0],
+          value_y: value.to_f * direction[1],
+          value_z: value.to_f * direction[2]
+        )
+      end
+
+      def initialize(value_x:, value_y:, value_z:)
+        @value_x = value_x.to_f
+        @value_y = value_y.to_f
+        @value_z = value_z.to_f
+      end
+
+      def magnitude
+        Math.sqrt(value_x**2 + value_y**2 + value_z**2)
+      end
+
+      def direction
+        vector_magnitude = magnitude
+
+        [
+          @value_x / vector_magnitude,
+          @value_y / vector_magnitude,
+          @value_z / vector_magnitude
+        ]
+      end
+    end
+  end
+end

data/lib/structuraid_core/errors/base.rb

@@ -0,0 +1,12 @@
+module StructuraidCore
+  module Errors
+    class Base < StandardError
+    end
+  end
+end
+
+require_relative 'design_codes/missing_param_error'
+require_relative 'design_codes/unknown_design_code_error'
+require_relative 'engineering/analysis/section_direction_error'
+require_relative 'reinforcement/empty_layers'
+require_relative 'reinforcement/invalid_distribution_direction'

data/lib/structuraid_core/errors/design_codes/missing_param_error.rb

@@ -0,0 +1,9 @@
+module StructuraidCore
+  module DesignCodes
+    class MissingParamError < StandardError
+      def initialize(param)
+        super("#{param} param is required")
+      end
+    end
+  end
+end

data/lib/structuraid_core/errors/design_codes/unknown_design_code_error.rb

@@ -0,0 +1,11 @@
+module StructuraidCore
+  module DesignCodes
+    class UnknownDesignCodeError < StandardError
+      def initialize(code_name)
+        message = "Design code #{code_name} is unknown. Must select one of #{DesignCodes::Resolver::CODES_NAMESPACES}"
+
+        super(message)
+      end
+    end
+  end
+end

data/lib/structuraid_core/errors/engineering/analysis/section_direction_error.rb

@@ -0,0 +1,13 @@
+module StructuraidCore
+  module Engineering
+    module Analysis
+      class SectionDirectionError < StandardError
+        def initialize(section_direction, valid_options)
+          message = "#{section_direction} is not a valid direction, should one of #{valid_options}"
+
+          super(message)
+        end
+      end
+    end
+  end
+end

data/lib/structuraid_core/errors/reinforcement/empty_layers.rb

@@ -0,0 +1,13 @@
+module StructuraidCore
+  module Elements
+    module Reinforcement
+      class EmptyLayers < StandardError
+        def initialize(complement)
+          message = "There are no layers #{complement}"
+
+          super(message)
+        end
+      end
+    end
+  end
+end

data/lib/structuraid_core/errors/reinforcement/invalid_distribution_direction.rb

@@ -0,0 +1,13 @@
+module StructuraidCore
+  module Elements
+    module Reinforcement
+      class InvalidDistributionDirection < StandardError
+        def initialize(distribution_direction, valid_directions)
+          message = "#{distribution_direction} is not a valid direction, should one of #{valid_directions}"
+
+          super(message)
+        end
+      end
+    end
+  end
+end

data/lib/structuraid_core/loads/base.rb

@@ -0,0 +1,9 @@
+module StructuraidCore
+  module Loads
+    class Base
+    end
+  end
+end
+
+require_relative 'point_load'
+require_relative 'uniform_load'

data/lib/structuraid_core/loads/point_load.rb

@@ -0,0 +1,13 @@
+module StructuraidCore
+  module Loads
+    class PointLoad < Base
+      attr_accessor :value
+      attr_reader :location
+
+      def initialize(value:, location:)
+        @value = value.to_f
+        @location = location
+      end
+    end
+  end
+end

data/lib/structuraid_core/loads/uniform_load.rb

@@ -0,0 +1,15 @@
+module StructuraidCore
+  module Loads
+    class UniformLoad < Base
+      attr_accessor :start_value, :end_value
+      attr_reader :start_location
+
+      def initialize(start_value:, end_value:, start_location:, end_location:)
+        @start_value = start_value.to_f
+        @end_value = end_value.to_f
+        @start_location = start_location
+        @end_location = end_location
+      end
+    end
+  end
+end

data/lib/structuraid_core/materials/base.rb

@@ -0,0 +1,10 @@
+module StructuraidCore
+  module Materials
+    class Base
+    end
+  end
+end
+
+require_relative 'concrete'
+require_relative 'soil'
+require_relative 'steel'

data/lib/structuraid_core/materials/concrete.rb

@@ -0,0 +1,13 @@
+module StructuraidCore
+  module Materials
+    class Concrete < Base
+      attr_reader :elastic_module, :design_compression_strength, :specific_weight
+
+      def initialize(elastic_module:, design_compression_strength:, specific_weight:)
+        @elastic_module = elastic_module.to_f
+        @design_compression_strength = design_compression_strength.to_f
+        @specific_weight = specific_weight.to_f
+      end
+    end
+  end
+end

data/lib/structuraid_core/materials/soil.rb

@@ -0,0 +1,11 @@
+module StructuraidCore
+  module Materials
+    class Soil < Base
+      attr_reader :bearing_capacity
+
+      def initialize(bearing_capacity:)
+        @bearing_capacity = bearing_capacity.to_f
+      end
+    end
+  end
+end

data/lib/structuraid_core/materials/steel.rb

@@ -0,0 +1,14 @@
+module StructuraidCore
+  module Materials
+    class Steel < Base
+      DEFAULT_ELASTIC_MODULE = 200_000
+
+      attr_reader :elastic_module, :yield_stress
+
+      def initialize(yield_stress:, elastic_module: DEFAULT_ELASTIC_MODULE)
+        @elastic_module = elastic_module.to_f
+        @yield_stress = yield_stress.to_f
+      end
+    end
+  end
+end

data/lib/structuraid_core/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module StructuraidCore
+  VERSION = '0.1.1'
+end

data/lib/structuraid_core.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'structuraid_core/version'
+
+module StructuraidCore
+end
+
+require_relative 'structuraid_core/db/base'
+require_relative 'structuraid_core/errors/base'
+require_relative 'structuraid_core/design_codes/base'
+require_relative 'structuraid_core/loads/base'
+require_relative 'structuraid_core/materials/base'
+require_relative 'structuraid_core/engineering/base'
+require_relative 'structuraid_core/elements/base'

data/sig/structuraid_core.rbs

@@ -0,0 +1,4 @@
+module StructuraidCore
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/structuraid_core.gemspec

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative 'lib/structuraid_core/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'structuraid_core'
+  spec.version = StructuraidCore::VERSION
+  spec.authors = ['Pradaing']
+  spec.email = ['engineering@pradic.co']
+
+  spec.summary = 'Gem with core utilities and functionality to design building structures'
+
+  description = <<-DESCRIPTION
+    structuraid_core is a gem that offers a set of functionalities to assist in the design building structures.
+  DESCRIPTION
+  spec.description = description.strip
+
+  spec.homepage = 'https://github.com/PradaIng/structuraid-core'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.1.2'
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/PradaIng/structuraid-core/blob/main/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'byebug', '~> 11.1.3'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7.3'
+  spec.add_development_dependency 'rspec', '~> 3.11.0'
+  spec.add_development_dependency 'rubocop', '~> 1.41.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.16.0'
+  spec.add_development_dependency 'simplecov', '~> 0.22.0'
+
+  spec.add_dependency 'rake', '~> 13.0.6'
+  spec.add_dependency 'require_all', '~> 3.0.0'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end