UniformRectilinearApi

All URIs are relative to http://localhost:50051

MethodHTTP requestDescription
getgridoriginGET /getgridorigin/{grid}
getgridshapeGET /getgridshape/{grid}
getgridspacingGET /getgridspacing/{grid}

getgridorigin

getgridorigin(api::UniformRectilinearApi, grid::Int64; _mediaType=nothing) -> Vector{Float64}, OpenAPI.Clients.ApiResponse <br/> getgridorigin(api::UniformRectilinearApi, response_stream::Channel, grid::Int64; _mediaType=nothing) -> Channel{ Vector{Float64} }, OpenAPI.Clients.ApiResponse

Get the coordinates of the lower-left corner of the model grid.

Required Parameters

NameTypeDescriptionNotes
_apiUniformRectilinearApiAPI context
gridInt64[default to nothing]

Return type

Vector{Float64}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getgridshape

getgridshape(api::UniformRectilinearApi, grid::Int64; _mediaType=nothing) -> Vector{Int64}, OpenAPI.Clients.ApiResponse <br/> getgridshape(api::UniformRectilinearApi, response_stream::Channel, grid::Int64; _mediaType=nothing) -> Channel{ Vector{Int64} }, OpenAPI.Clients.ApiResponse

Get the dimensions of the model grid.

Required Parameters

NameTypeDescriptionNotes
_apiUniformRectilinearApiAPI context
gridInt64[default to nothing]

Return type

Vector{Int64}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getgridspacing

getgridspacing(api::UniformRectilinearApi, grid::Int64; _mediaType=nothing) -> Vector{Float64}, OpenAPI.Clients.ApiResponse <br/> getgridspacing(api::UniformRectilinearApi, response_stream::Channel, grid::Int64; _mediaType=nothing) -> Channel{ Vector{Float64} }, OpenAPI.Clients.ApiResponse

Get the distance between the nodes of the model grid.

Required Parameters

NameTypeDescriptionNotes
_apiUniformRectilinearApiAPI context
gridInt64[default to nothing]

Return type

Vector{Float64}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]