miSim/@miSim/miSim.m

classdef miSim
    % multiagent interconnection simulation

    % Simulation parameters
    properties (SetAccess = public, GetAccess = public)
        timestep = NaN; % delta time interval for simulation iterations
        timestepIndex = NaN; % index of the current timestep (useful for time-indexed arrays)
        maxIter = NaN; % maximum number of simulation iterations
        domain;
        obstacles; % geometries that define obstacles within the domain
        agents; % agents that move within the domain
        adjacency = false(0, 0); % Adjacency matrix representing communications network graph
        constraintAdjacencyMatrix = false(0, 0); % Adjacency matrix representing desired lesser neighbor connections
        partitioning = zeros(0, 0);
        perf; % sensor performance timeseries array
        performance = 0; % simulation performance timeseries vector
        barrierGain = NaN; % CBF gain parameter
        barrierExponent = NaN; % CBF exponent parameter
        minAlt = 0; % minimum allowable altitude (m)
        useDoubleIntegrator = false; % false = single-integrator, true = double-integrator dynamics
        dampingCoeff = 2.0; % velocity-proportional damping for double-integrator mode
        useFixedTopology = false; % false = lesser neighbor (dynamic), true = fixed initial topology
        optimizeSensorPointing = false; % false = fixed sensor tilt/azimuth, true = optimize tilt/azimuth via gradient ascent
        % Communications model selection and SINR-model parameters.
        % useSinrComms = false -> fixed-radius comms (comRange / commsGeometry).
        % useSinrComms = true  -> SINR/path-loss comms (txPower + params below).
        useSinrComms = false;
        sinrThreshold = 0;        % SINR threshold for connectivity & CBF maintenance (dB)
        pathLossExponent = 2.0;   % path-loss exponent n in S = P / (K * d^n)
        ambientTemp = 290.0;      % ambient temperature (K) for thermal noise N = k_B*T*B
        centerFreq = 2.4e9;       % carrier frequency (Hz); sets path-loss offset K = (4*pi*f_c/c)^2
        bandwidth = 20e6;         % channel bandwidth (Hz) for thermal noise N = k_B*T*B
        % Topology-selection algorithm (requires useSinrComms; MATLAB sim only).
        % false -> lesser-neighbor; true -> min-max-workload LP routing, which
        % picks the links that route all sensing data to the network endpoints
        % (agents 1 and the largest odd index) with minimal peak node workload.
        useRoutingTopology = false;
        routingFlowThreshold = 0.02;  % prune links carrying less flow than this (units of one node's production)
        routingAdjacencyMatrix = false(0, 0); % directed adjacency chosen by the routing LP: (i, j) = link i -> j
        routingFlows = zeros(0, 0);   % data flow carried by each directed link (units/timestep)
        artifactName = "";
        f; % main plotting tiled layout figure
        fPerf; % performance plot figure
        % Indicies for various plot types in the main tiled layout figure
        spatialPlotIndices = [6, 4, 3, 2];
        numBarriers = 0; % Number of barrier functions needed
        barriers = []; % log barrier function values at each timestep for analysis
        constraintAdjacencyHist = []; % log constraint adjacency matrix at each timestep
    end

    properties (Access = private)
        % Sim
        t = NaN; % current sim time
        times;
        partitioningTimes;

        % Plot objects
        makePlots = true; % enable/disable simulation plotting (performance implications)
        makeVideo = true; % enable/disable VideoWriter (performance implications)
        connectionsPlot; % objects for lines connecting agents in spatial plots
        graphPlot; % objects for abstract network graph plot
        partitionPlot; % objects for partition plot
        performancePlot; % objects for sensor performance plot

        posHist; % data for trail plot
        velHist; % velocity history (double-integrator mode)
        trailPlot; % objects for agent trail plot

        % Indicies for various plot types in the main tiled layout figure
        objectivePlotIndices = [6, 4];
        networkGraphIndex = 5;
        partitionGraphIndex = 1;

        % CBF plotting
        hf; % h function plotting figure
        caPlot; % objects for collision avoidance h function plot
        obsPlot; % objects for obstacle h function plot
        domPlot; % objects for domain h function plot
    end

    methods (Access = public)
        function obj = miSim()
            arguments (Output)
                obj (1, 1) miSim
            end
            obj.domain = rectangularPrism;
            obj.obstacles = {rectangularPrism};
            obj.agents = {agent};
        end
        [obj] = initialize(obj, domain, agents, barrierGain, barrierExponent, minAlt, timestep, maxIter, obstacles, makePlots, makeVideo, useDoubleIntegrator, dampingCoeff, useFixedTopology, optimizeSensorPointing, useSinrComms, sinrThreshold, pathLossExponent, ambientTemp, centerFreq, bandwidth, useRoutingTopology, routingFlowThreshold);
        [obj] = initializeFromCsv(obj, csvPath);
        [obj] = initializeFromInits(obj, initsPath);
        [obj] = plotFromSimHist(obj, initsPath, histPath);
        [obj] = run(obj);
        [obj] = lesserNeighbor(obj);
        [obj] = routeTopology(obj);
        [obj] = constrainMotion(obj);
        [sinr, grad] = sinrLink(obj, positions, rxIdx, txIdx);
        [obj] = partition(obj);
        [obj] = updateAdjacency(obj);
        [obj] = plot(obj);
        [obj] = plotConnections(obj);
        [obj] = plotPartitions(obj);
        [obj] = plotGraph(obj);
        [obj] = plotTrails(obj);
        [obj] = plotH(obj);
        [obj] = updatePlots(obj);
        [obj] = teardown(obj);
        writeInits(obj);
        validate(obj);
    end
    methods (Access = private)
        [v] = setupVideoWriter(obj);
    end
end