disk_searchableSurface.C

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2014-2025 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
\*---------------------------------------------------------------------------*/
 
#include "disk_searchableSurface.H"
#include "addToRunTimeSelectionTable.H"
 
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
 
namespace Foam
{
    namespace searchableSurfaces
    {
        defineTypeNameAndDebug(disk, 0);
 
        addToRunTimeSelectionTable
        (
            searchableSurface,
            disk,
            dictionary
        );
 
        addBackwardCompatibleToRunTimeSelectionTable
        (
            searchableSurface,
            disk,
            dictionary,
            searchableDisk,
            "searchableDisk"
        );
    }
}
 
 
// * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
 
Foam::pointIndexHit Foam::searchableSurfaces::disk::findNearest
(
    const point& sample,
    const scalar nearestDistSqr
) const
{
    pointIndexHit info(false, sample, -1);
 
    vector v(sample - origin_);
 
    // Decompose sample-origin into normal and parallel component
    scalar parallel = (v & normal_);
 
    // Remove the parallel component and normalise
    v -= parallel*normal_;
    scalar magV = mag(v);
 
    if (magV < rootVSmall)
    {
        v = Zero;
    }
    else
    {
        v /= magV;
    }
 
    // Clip to radius.
    info.setPoint(origin_ + min(magV, radius_)*v);
 
    if (magSqr(sample - info.rawPoint()) < nearestDistSqr)
    {
        info.setHit();
        info.setIndex(0);
    }
 
    return info;
}
 
 
void Foam::searchableSurfaces::disk::findLine
(
    const point& start,
    const point& end,
    pointIndexHit& info
) const
{
    info = pointIndexHit(false, Zero, -1);
 
    vector v(start - origin_);
 
    // Decompose sample-origin into normal and parallel component
    scalar parallel = (v & normal_);
 
    if (sign(parallel) == sign((end - origin_) & normal_))
    {
        return;
    }
 
    // Remove the parallel component and normalise
    v -= parallel*normal_;
    scalar magV = mag(v);
 
    if (magV < rootVSmall)
    {
        v = Zero;
    }
    else
    {
        v /= magV;
    }
 
    // Set (hit or miss) to intersection of ray and plane of disk
    info.setPoint(origin_ + magV*v);
 
    if (magV <= radius_)
    {
        info.setHit();
        info.setIndex(0);
    }
}
 
 
// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
Foam::searchableSurfaces::disk::disk
(
    const IOobject& io,
    const point& origin,
    const point& normal,
    const scalar radius
)
:
    searchableSurface(io),
    origin_(origin),
    normal_(normal/mag(normal)),
    radius_(radius)
{
    // Rough approximation of bounding box
    // vector span(radius_, radius_, radius_);
 
    // See cylinder
    vector span
    (
        sqrt(sqr(normal_.y()) + sqr(normal_.z())),
        sqrt(sqr(normal_.x()) + sqr(normal_.z())),
        sqrt(sqr(normal_.x()) + sqr(normal_.y()))
    );
    span *= radius_;
 
    bounds().min() = origin_ - span;
    bounds().max() = origin_ + span;
}
 
 
Foam::searchableSurfaces::disk::disk
(
    const IOobject& io,
    const dictionary& dict
)
:
    searchableSurface(io),
    origin_(dict.lookup<point>("origin", dimLength)),
    normal_(dict.lookup<vector>("normal", dimless)),
    radius_(dict.lookup<scalar>("radius", dimLength))
{
    normal_ /= mag(normal_);
 
    // Rough approximation of bounding box
    // vector span(radius_, radius_, radius_);
 
    // See cylinder
    vector span
    (
        sqrt(sqr(normal_.y()) + sqr(normal_.z())),
        sqrt(sqr(normal_.x()) + sqr(normal_.z())),
        sqrt(sqr(normal_.x()) + sqr(normal_.y()))
    );
    span *= radius_;
 
    bounds().min() = origin_ - span;
    bounds().max() = origin_ + span;
}
 
 
// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 
Foam::searchableSurfaces::disk::~disk()
{}
 
 
// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
const Foam::wordList& Foam::searchableSurfaces::disk::regions() const
{
    if (regions_.empty())
    {
        regions_.setSize(1);
        regions_[0] = "region0";
    }
    return regions_;
}
 
 
void Foam::searchableSurfaces::disk::boundingSpheres
(
    pointField& centres,
    scalarField& radiusSqr
) const
{
    centres.setSize(1);
    centres[0] = origin_;
 
    radiusSqr.setSize(1);
    radiusSqr[0] = sqr(radius_);
 
    // Add a bit to make sure all points are tested inside
    radiusSqr += Foam::sqr(small);
}
 
 
void Foam::searchableSurfaces::disk::findNearest
(
    const pointField& samples,
    const scalarField& nearestDistSqr,
    List<pointIndexHit>& info
) const
{
    info.setSize(samples.size());
 
    forAll(samples, i)
    {
        info[i] = findNearest(samples[i], nearestDistSqr[i]);
    }
}
 
 
void Foam::searchableSurfaces::disk::findLine
(
    const pointField& start,
    const pointField& end,
    List<pointIndexHit>& info
) const
{
    info.setSize(start.size());
 
    forAll(start, i)
    {
        findLine(start[i], end[i], info[i]);
    }
}
 
 
void Foam::searchableSurfaces::disk::findLineAny
(
    const pointField& start,
    const pointField& end,
    List<pointIndexHit>& info
) const
{
    findLine(start, end, info);
}
 
 
void Foam::searchableSurfaces::disk::findLineAll
(
    const pointField& start,
    const pointField& end,
    List<List<pointIndexHit>>& info
) const
{
    info.setSize(start.size());
 
    forAll(start, i)
    {
        pointIndexHit inter;
        findLine(start[i], end[i], inter);
 
        if (inter.hit())
        {
            info[i].setSize(1);
            info[i][0] = inter;
        }
        else
        {
            info[i].clear();
        }
    }
}
 
 
void Foam::searchableSurfaces::disk::getRegion
(
    const List<pointIndexHit>& info,
    labelList& region
) const
{
    region.setSize(info.size());
    region = 0;
}
 
 
void Foam::searchableSurfaces::disk::getNormal
(
    const List<pointIndexHit>& info,
    vectorField& normal
) const
{
    normal.setSize(info.size());
    normal = normal_;
}
 
 
void Foam::searchableSurfaces::disk::getVolumeType
(
    const pointField& points,
    List<volumeType>& volType
) const
{
    FatalErrorInFunction
        << "Volume type not supported for disk."
        << exit(FatalError);
}
 
 
// ************************************************************************* //