plane_init Function

private function plane_init(a, optProp, layer, transform) result(out)

Initalising function for plane SDF.

Arguments

Type IntentOptional Attributes Name
type(vector), intent(in) :: a

Plane normal. must be normalised

type(opticalProp_t), intent(in) :: optProp

Optical properties of the SDF

integer, intent(in) :: layer

ID number of sdf

real(kind=wp), intent(in), optional :: transform(4,4)

Optional transform to apply to SDF

Return Value type(plane)


Source Code

    function plane_init(a, optProp, layer, transform) result(out)
        !! Initalising function for plane SDF.

        type(plane) :: out
        
        !> Plane normal. must be normalised
        type(vector),             intent(IN) :: a
        !> ID number of sdf
        integer,                  intent(IN) :: layer
        !> Optional transform to apply to SDF
        real(kind=wp),  optional, intent(IN) :: transform(4, 4)
        !> Optical properties of the SDF
        type(opticalProp_t),      intent(in) :: optProp

        real(kind=wp) :: t(4, 4)

        if(present(transform))then
            t = transform
        else
            t = identity()
        end if

        out%a = a
        out%layer = layer
        out%transform = t

        out%optProps = optProp

    end function plane_init